Skip to main content
Wake-on-LAN
NetworkingSourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Status check intervalnumber60Seconds between status checks. Checks through a relay host use SSH each time.
Allow commands on the Termix serverbooleanfalseLet saved ping, wake and shutdown commands run on the Termix server. Only users with the Use the Termix server permission can save them.

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
PowerbooleanfalseShow this host on the Power tab.
MAC addressstringThe MAC address of the network port that wakes this host.
Broadcast addressstringThe subnet broadcast address to send the packet to. Leave blank for 255.255.255.255.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
wake-on-lan.sendadmin, userWake a host from the Power tab, its menu or an automation.
wake-on-lan.shutdownadmin, userShut down a host or put it to sleep.
wake-on-lan.scanadmin, userLook for machines from an SSH host you can connect to.
wake-on-lan.server-commandsadminSave commands that run on the Termix server, and scan from it. This can run anything the server can.

Actions​

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

ActionRuns onRiskInputs
wake-on-lan.wake
Wake machine
A hostChanges
wake-on-lan.shutdown
Shut down machine
A hostChanges
wake-on-lan.sleep
Put machine to sleep
A hostChanges
wake-on-lan.power-state
Power state
A hostRead only

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
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
process:spawnHighRun programs on this machine. Programs run on the Termix server itself, not on your hosts.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
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.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
network:broadcastMediumSend network broadcasts. It can send packets to devices on the local network, such as a Wake-on-LAN signal.
network:outboundMediumReach the internet. It can send requests to outside services.
network:probeMediumCheck if ports answer. Can open a plain connection to any address from the server, to see if it is reachable, and look up host names.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
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.

Works with other plugins​

Works better with: out-of-band ^1.0.0.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
wake-on-lan.send1.0.0wake-on-lan.send
UsesVersionOptional
out-of-band.power^1.0.0yes

API​

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

Platforms​

Linux, Windows, macOS