Skip to main content
Ansible
InfrastructureSourceAPIChangelog

Reference

Settings​

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
AnsiblebooleanfalseUse this host as an Ansible control host. Ansible must be installed on it.
Project folderstring"~/ansible"The folder on this host with your playbooks, roles and ansible.cfg.
Vault password filestringA file on this host with the Ansible Vault password. Leave empty if you do not use Vault.
Read onlybooleanfalseShow playbooks and runs but never edit files or start runs on this host.
Alert when a run failsbooleantrueSend an alert when a run on this host ends failed or lost. Checked when run state is read.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
ansible.useadmin, userSee playbooks and runs on control hosts you can reach. Edit files and run Ansible on hosts you can edit.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
ansible.list-playbooks
List playbooks
A hostRead only
ansible.list-runs
List runs
A hostRead only
ansible.failed
Failed runs
A hostRead only
ansible.run-playbook
Run playbook
A hostChangesplaybook, limit, tags, check

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:serveMediumAccept connections. It opens a port on the Termix server.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
kv:ownLowRemember small settings. Kept separate from other plugins.

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS