stephb9959
2023-03-08 11:10:41 -08:00
parent 9f632ad794
commit ddf209ebc5

76
CLI.md
View File

@@ -7,139 +7,139 @@ cli help
## The commands
### getdevice <serial>
### getdevice `serial`
Get the device JSON document.
### deletedevice <serial>
### deletedevice `serial`
Delete the device.
### createdevice <serial> <cfg> <MAC>
### createdevice `serial` `cfg` `MAC`
Create a device using the default configuration.
- `serial`: device serial number
- `cfg`: JSON config file name
- `MAC`: string MAC Address
### getdevicestatus <serial>
### getdevicestatus `serial`
Get the device status JSON document.
- `serial`: device serial number
### getstats <serial>
### getstats `serial`
Get statistics for the device.
- `serial`: device serial number
### gethealthchecks <serial>
### gethealthchecks `serial`
Get healthchecks for a device.
- `serial`: device serial number
### newesthealthchecks <serial>
### newesthealthchecks `serial`
Get newest healthchecks for a device.
- `serial`: device serial number
### lasthealthcheck <serial>
### lasthealthcheck `serial`
Get the last healthcheck
- `serial`: device serial number
### getcapababilities <serial>
### getcapababilities `serial`
Get the device capabilities JSON document.
- `serial`: device serial number
### deletecapababilities <serial>
### deletecapababilities `serial`
Delete the device capabilities JSON.
- `serial`: device serial number
### reboot <serial>
### reboot `serial`
Reboot the device.
- `serial`: device serial number
### upgrade <serial> <URI>
### upgrade `serial` `URI`
Do firmware upgrade for a device.
- `serial`: device serial number
- `URI`: complete URI where the upgrade file exists. No validation is performed.
### leds <serial> <pattern> <duration>
### leds `serial` `pattern` `duration`
Activate LEDs a device.
- `serial`: device serial number
- `pattern`: on/off/blink
- `duration`: number in seconds
### configure <serial> <cfg>
### configure `serial` `cfg`
Change configuration for a device.
- `serial`: device serial number
- `cfg`: JSON config file name
### factory <serial> <keep_redirector>
### factory `serial` `keep_redirector`
Do factory reset for device.
- `serial`: device serial number
- `keep_redirector`: true=keep redirector, false=reset redirector
### request <serial> <message>
### request `serial` `message`
Force a message from the device.
- `serial`: device serial number
- `message`: state or healthcheck
### wifiscan <serial> <verbose>
### wifiscan `serial` `verbose`
Do wifiscan for a device.
- `serial`: device serial number
- `verbose`: verbose=true/false
### telemetry <serial>
### telemetry `serial`
Start `telemetry` stream for a device.
### trace <serial> <duration> <network>
### trace `serial` `duration` `network`
Launch a remote trace for a device.
- `serial`: device serial number
- `duration`: number in seconds
- `network`: which network to perform trace on: lan or wan
### getcommand <command-uuid>
### getcommand `command-uuid`
Get the command JSON document.
- `command-uuid`: command UUID
### deletecommand <command-uuid>
### deletecommand `command-uuid`
Delete the command.
- `command-uuid`: command UUID
### newestcommands <serial>
### newestcommands `serial`
Get the newest commands for a device.
- `serial`: device serial number
### listdevices
List devices.
### listcommands <serial>
### listcommands `serial`
List commands for a specific device.
- `serial`: device serial number
### deletecommands <serial>
### deletecommands `serial`
Delete commands for a device.
- `serial`: device serial number
### getlogs <serial>
### getlogs `serial`
Get logs for the device.
- `serial`: device serial number
### newestlogs <serial>
### newestlogs `serial`
Get the latest logs for the device.
- `serial`: device serial number
### deletelogs <serial>
### deletelogs `serial`
Delete logs for the device.
- `serial`: device serial number
### eventqueue <serial>
### eventqueue `serial`
Request event queue for the device.
- `serial`: device serial number
### listdefaultconfigs
List default configurations.
### createdefaultconfig <name> <ids> <cfg>
### createdefaultconfig `name` `ids` `cfg`
Create a default configuration
- `name`: unique name, no spaces
- `ids`: comma separated list of models
- `cfg`: JSON config file name
### addblacklistdevice <serial> <reason>
### addblacklistdevice `serial` `reason`
Add a device to the black list
- `serial`: serial number of the device to add
- `reason`: reason for blacklisting
@@ -147,7 +147,7 @@ Add a device to the black list
### getblacklist
List all blacklisted devices
### deleteblacklistdevice <serial>
### deleteblacklistdevice `serial`
Add a device to the black list.
- `serial`: device serial number
@@ -157,7 +157,7 @@ Get the number of devices in the DB.
### deviceserialnumbers
Get only the serial numbers.
### selectdevices <serial_list>
### selectdevices `serial_list`
Get a list of devices based on a list.
- `serial_list`: serial numbers (must be comma separated).
@@ -179,28 +179,28 @@ Get the list of subsystems.
### systeminfo
Get basic system information.
### reloadsubsystem <subsystem name>
### reloadsubsystem `subsystem name`
Reload the configuration for a subsystem.### getfile <uuid>
Get the file associated with trace command <uuid>.
- `uuid`: UUID of file to retrieve
### rtty <serial>
### rtty `serial number`
Get the details for an rtty session.
- `serial`: device serial number
### lifetimestats <serial>
### lifetimestats `serial number`
Get the lifetime stats counters for a device
- `serial`: device serial number
### laststats <serial>
### laststats `serial number`
Get the last statistics for a device.
- `serial`: device serial number
### neweststats <serial>
### neweststats `serial number`
Get the newest statistics for a device.
- `serial`: device serial number
### deviceping <serial>
### deviceping `serial number`
This will return you the end-to-end latency from command-line to return value.
## Notes