Skip to main content
Fleets
InfrastructureSourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Retries after a connection timeoutnumber2How 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 retriesnumber5How long to wait before trying a timed out host again.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Always show buttonsbooleanfalseKeep 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.

PermissionWho has it at firstWhat it allows
fleets.viewuserSee fleets, their members and inventory.
fleets.manageuserCreate, edit and delete fleets, change membership, and share fleets with other users or roles.
fleets.executeuserRun 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.

ActionRuns onRiskInputs
fleets.list-fleets
List fleets
The serverRead only
fleets.run-command
Run a command
A hostChangescommand
fleets.exec
Run a command and report
A hostDestructivecommand, 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.

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.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
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.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd 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.

ProvidesVersionPermission
fleets.access1.0.0fleets.view

API​

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

Platforms​

Linux, Windows, macOS