SiteManager command-line interface
SiteManager provides a command-line interface for managing displays from a command prompt or terminal. This can be useful when managing displays over SSH connections or other remote connections.
Overview
Almost all console commands produce output in JSON format so that it is relatively easy to parse by machines.
Specifying hosts
Commands that target one or more displays accept the target using [--hosts]{.title-ref} argument, followed by one or more hosts separated by commas. For example, to specify a single host:
sitemanager --hosts 10.77.84.100 --info
To specify multiple hosts, separate the hosts by commas:
sitemanager --hosts "10.77.84.100,10.77.84.101" --info
Note
In the command examples later in the manual this is denoted by [[HOSTS]]{.title-ref}.
Getting and setting values
All commands that read or write the value of a parameter follow the same overall logic:
To get a value
: Specify the parameter name after double dashes: [--\<parameter name>]{.title-ref}. For example:
``` bash
sitemanager --hosts 10.77.84.100 --video.source
```
To set a value
: Specify the parameter name after double dashes followed by its value: [--\<parameter name> \<parameter value>]{.title-ref}. For example:
``` bash
sitemanager --hosts 10.77.84.100 --video.source osd
```
Note
Just like modifying parameter values from OSD, any changes made by SiteManager are not saved by default and will be lost when a display is rebooted. Use [--settings.save]{.title-ref} or [--settings.discard]{.title-ref} to save or discard any changes made.
Return values
The following process exit codes are used for SiteManager:
Exit code Description
0 All supplied commands were successfully executed on all specified hosts 1 Catchall for general errors 2 One or more hosts failed 3 One or more hosts were unreachable 4 Parsing error (invalid user input)
More exit codes can be added in future updates.
Scanning displays
To scan displays from the given network and display their basic information, use the [--scan \<subnet>]{.title-ref} command. The subnet is specified in CIDR format. If no subnet is specified, one is chosen based on the currently configured networks on the computer running SiteManager.
sitemanager --scan=<subnet>
Displaying information
To displays static information about a device given its host address, use the [--info]{.title-ref} command.
sitemanager [HOSTS] --info
Device status
Give basic information about a status of a display, use the [--status]{.title-ref} command.
sitemanager [HOSTS] --status
Usage and help
To see all commands that the SiteManager command-line interface supports, run the software without any arguments or with [--help]{.title-ref}.
sitemanager --help