> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/2-6-1/guides/ansible.md).

# Ansible

Integrate Connectware into your automation workflows using the ready-made Ansible roles and playbooks.

The Connectware Ansible collection enables you to fully automate all configuration options available in the Connectware web interface. Instead of performing manual steps in the Admin UI, you can declaratively manage Connectware and its components as code.

With this collection, you can:

* **Install and manage Connectware**: Ensure that Connectware is present or absent, start, stop, or restart instances, and define installation details such as paths, custom compose files, or environment properties.
* **Automate service lifecycle management**: Deploy services from service commissioning files and enable, disable, restart, or remove them.
* **Control roles, permissions, and users**: Define roles and permissions directly in your playbooks to manage user access.
* **Operate Connectware agents**: Handle agent setup, control their running state, and configure advanced options like agent naming or restart policies.

## Connectware Ansible Collection

The official Ansible collection for Connectware is available on [Ansible Galaxy](https://galaxy.ansible.com/ui/repo/published/cybus/connectware/docs/). There you will find documentation, usage examples, and guidance on how to extend the roles to fit your environment.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cybus.io/2-6-1/guides/ansible.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.