This web application allows you to browse the object tree of the LTOS CLI and RESTAPI structures in order to get descriptions of all possible API and CLI objects and commands.
You can download this documentation from a device using the URL https://[IP of device]/clihelp.zip if you want to store and access it on a PC. Please download the ZIP archive and extract its contents to an empty folder on your harddisk, then open the "index.html" file with your web browser.
You can expand and collapse a sub-menu item by just clicking on its name or the arrow in front of it. If you click on an object or command item, its description will be shown on the right panel.
A search field in the upper right corner will allow you to quickly find any command, sub-menu or object. Just enter any search text in it and all matching elements will be marked in the left-panel tree. This will automatically expand the required menus as well.
The top level of the tree shows two sub-menus. The first one is “global-commands” which contains all those CLI commands which are accessible no matter in which sub-menu you changed before.
Some of these commands are also available via the REST API, this is mentioned in the description.
The second Top Level sub menu is “main-menu” which represents the root of the CLI and API structures. For example, the tree-path main-menu/status/network0/ports/lan[ID]/speed points to the link speed status object of a LAN interface (the [ID] placeholder can be replaced with any of the existing LAN interface IDs, e.g. 0 for the very first physical network interface).
In order to access this object from within the CLI, the path would be /status/network/ports/lan0/speed and its current value could be read by using the “get” CLLI command (or, as a shortcut, just entering the path itself which has the same effect):
root:/ > get /status/network/ports/lan0/speed
speed: 1000
root:/ > _
To access the same object via the REST API, the following link would be used:
https://[IP of the device]/api/status/network/ports/lan0/speed
For objects that have enum values, i.e. there is a fixed list of possible values for the object, the value can be returned in two different ways in a query. As a default, the value is shown as a string-representation, e.g. "ocxo-hq". Each enum value can also be represented by an integer value by sending the raw option together with the query. This is demonstrated for the osc-type object (and all other enum objects) in the following two examples:
Example 1: https://[IP of device]/api/status/system/sync-status (string representation of enum values)
Example 2: https://[IP of device]/api/status/system/sync-status?raw (numeric representation of enum values)
Below main-menu there are two sub menus, “status” and “configuration”. Clicking on a sub menu item will expand it in the tree-panel and also brings up a description of the menu inthe right panel. This is also works for commands and objects.
The description for menus includes all the sub-menus and objects it contains. There is also a “See also” section which offers direct links to the description of those objects and sub-menus.
To show the contents of an entire sub-menu in the CLI, the “view” command is used:
root:/ > view /status/system/sync-status/
sync-status
clock-status
clock "holdover [2]"
oscillator "not-warmed-up [0]"
antenna "disconnected [1]"
end #clock-status
holdover-status
time-offset 938820 nanoseconds
time-elapsed 175551 seconds
end #holdover-status
reference "clk1 none"
ref-type "none [255]"
clock-idx 0
osc-type "ocxo-sq [10]"
est-time-quality "less-than-100ns [6]"
end #sync-status
root:/ >
Please note that there are multiple output formats available for the view command (see “view –help” for a list.
If applicable, a RESTAPI link is provided as well. Clicking on the link will automatically send a GET request to the corresponding RESTAPI container, resulting in the JSON formatted response to be shown in the right panel. Please note that this API link only works if the API has been enabled on the system on which the clihelp web application is used. If a sub-menu is not supported via the RESTAPI, this is mentioned. In this case there will not be a link provided.
Accessing the contents of a sub menu with the REST API is as easy as just specifying the path to the sub-menu in the URL:
GET https://[IP of device]/api/status/system/sync-status
which will retrieve the entire contents of the sync-status sub-menu in JSON format:
{
"system-information": {
"version": "",
"serial-number": "",
"hostname": " ",
"time-stamp": "2021-02-26T10:06:25",
"model": ""
},
"data": {
"object-id": "sync-status",
"clock-status": {
"clock": "holdover",
"oscillator": "not-warmed-up",
"antenna": "disconnected"
},
"holdover-status": {
"time-offset": 941258,
"time-elapsed": 175779
},
"reference": "clk1 none",
"ref-type": "none",
"clock-idx": 0,
"osc-type": "ocxo-sq",
"est-time-quality": "less-than-100ns"
},
"links": {
"self": "http://[IP of the device]/api/status/system/sync-status"
}
}
The description of commands will include the parameters and an explanation how to use the command, together with a reference to other, related commands. If a command can also be used with the REST API, this will be mentioned as well, including the HTTP method (verb) that has to be used. Please note that for all RESTAPI links which are not usable with GET, there will be no active link provided in clihelp.
The description of objects will include information about the data-type of the values it can hold. It will also be indicated if this is a read-write object (i.e. for configuration parameters) or a read-only object (for status objects).
If applicable, a description of valid values is also included in an object description, for example an allowed range for integer values or the min/max length of string values.
For enum objects, i.e. objects there is a list of valid entries in the description, with both the text representation (e.g. “free-running”) and the numeric representation (1 in this example for the /status/system/sync-status/clock-status object).
A JSON model of all available RESTAPI objects can be downloaded from the URL
https://[IP of device]/clihelp/capabilities/restapi-capabilities.json
This model contains all objects and their attributes as well as validation parameters (datatype, min/max values, enums, string regex checks etc.).