Skip to main content
Sync
InfrastructureSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Alert when a site can not be reachedbooleantrueSend an alert when a remote site stops answering and when it comes back.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
sync.sitesadminAdd, edit and remove remote Termix sites and open sessions on their hosts.

Actions​

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

ActionRuns onRiskInputs
sync.list-sites
List remote sites
The serverRead only
sync.refresh-site
Refresh remote site
The serverChangessite

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
sync:provideHighRun sync. It can answer all sync requests, so it sees the data that devices and servers sync.
ssh:transportHighChoose how hosts are reached. It can carry the SSH connection to a host over its own route, so it sees everything sent to and from those hosts, passwords included.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
hosts:lockMediumManage hosts as read only. Hosts it manages can't be edited, deleted or reshared by anyone else.
network:outboundMediumReach the internet. It can send requests to outside services.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
kv:ownLowRemember small settings. Kept separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

API​

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

Platforms​

Linux, Windows, macOS