Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Retries after a connection timeout | number | 2 | How many more times a fleet action tries a host whose SSH connection timed out. Only the failed hosts try again, and nothing runs twice. |
| Seconds between retries | number | 5 | How long to wait before trying a timed out host again. |
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Always show buttons | boolean | false | Keep the share, edit and delete buttons under each fleet visible. Turn off to show them only on hover. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
fleets.view | user | See fleets, their members and inventory. |
fleets.manage | user | Create, edit and delete fleets, change membership, and share fleets with other users or roles. |
fleets.execute | user | Run commands and package actions across a fleet, and transfer files to and from its member hosts. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
fleets.list-fleetsList fleets | The server | Read only | |
fleets.run-commandRun a command | A host | Changes | command |
fleets.execRun a command and report | A host | Destructive | command, timeoutSeconds |
Capabilities
What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.
| Capability | Risk | What it means |
|---|---|---|
credentials:read | Critical | See your passwords and keys. It can read the stored secret for any host you can reach. |
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
hosts:write | Medium | Create and change hosts. It can add hosts and edit the ones you already have. |
credentials:use | Medium | Connect to your servers. It cannot see your passwords or keys. |
network:serve | Medium | Accept connections. It opens a port on the Termix server. |
operations:provide | Medium | Offer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them. |
hosts:read | Low | See your host list. Names and addresses for hosts you can already see. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
Works with other plugins
Works better with: snippets ^1.0.0.
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
fleets.access | 1.0.0 | fleets.view |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS