![]() | |
| HomeStoreNewsProductsPricingSupportInstallationsCorporateContact ASTi | |
|
ASTi Application Note 88: Command Line Interface
ASTi CommandsRadio Commands
asti-cmd radio <radio name> <radio operation> [<radio operation> …]
Where radio operation is one of the following:
set-id <protocol identifier> set-domain <domain name> get-status get-changecount
The get-status operation returns a set of name=value pairs. For example, if a radio is set as follows:
Command: cmd> asti-smd radio vhf1 set-id 3 Return: rsp> 1
Then a subsequent exchange might be:
Command: cmd> asti-cmd radio get-status Return: rsp> set-id="3"
The get-changecount operation returns the current update changecount number of the specified radio or entity. A value of zero indicates that there are no host-specified updates applied to the radio or entity, it otherwise increments sequentially with each update.
Example ASTi Radio Commandssshentity.txt:asti-cmd radio Radio set-id DIS:1.2.1.1 sshentity.txt:asti-cmd radio Radio set-id DIS:4.4.4.4:TstEntity3 sshentity.txt:asti-cmd radio Radio set-id DIS:243 sshentity.txt:asti-cmd radio Radio set-domain DIS:1 DIS Radio Commands
asti-cmd dis-radio <radio name> <dis radio operation> [<dis radio operation> …]
Where dis radio operation is one of the following:
set-id <dis protocol identifier> set-exercise <dis exercise number>
The dis protocol identifier is a two- or four-part number each of which must be in the range 1 to 65535. The two forms are:
<site>.<app>.<entity>.<radio> <entity>.<radio> (site and app use defaults)
Add a marking field specification by appending a colon and the marking field value:
1.2.3.4:viper2
The above example sets the default radio ID to 1.2.3.4 for use when a matching entity is not present. When an entity with a matching marking field (viper2) becomes present, the site.app.entity. IDs are derived from that matching entity.
The dis exercise number must be in the range of 1 to 255.
All of the set-… operations also return the resulting changecount number.
If a value of -1 is returned this indicates a syntax error occurred on an operation and a corresponding diagnostic message is written to the system log.
Example ASTi DIS Radio Commandssshentity.txt:asti-cmd dis-radio Radio set-id 1.2.1.1 sshentity.txt:asti-cmd dis-radio Radio set-id 4.4.4.4:TstEntity3 sshentity.txt:asti-cmd dis-radio Radio set-id 8.243 sshentity.txt:asti-cmd dis-radio Radio set-exercise 2 ACE User Commands
The ace-user command allows the user to retrieve key information about the Target and to control certain aspects of the Target. This command is not intended to duplicate the more detailed information available via RMS.
The following subcommands are available for the ace-user command:
health: display health summary help: display command list install-layout: install a layout load: install the default load on Target status: display status of Target
The following subcommands are available for the ace-user command in software version 4.20 or above:
start: starts the load stop: stops the load reboot: reboots the Target shutdown: shuts down the Target ace-user health
The ace-user health command returns an exit status of 0 if the Target's health indicates no errors or a non-zero status if errors exist. To verify this, issue the command echo $? immediately after issuing the desired ace-user health command. Additionally, several levels of verbosity may be specified. See the examples below.
Example 1:
Health status with minimal verbosity requested when no errors exist. Command: ace-user health Return: Status: Good
Example 2:
Health status with minimal verbosity requested when model is not running. Command: ace-user health Return: Status: Model not running
Example 3:
Health status with minimal verbosity requested when errors exist. Command: ace-user health Return: Status: Errors exist
Example 4:
Health status with medium verbosity requested when errors exist. Command: ace-user health -v Return: Status: Errors exist ace-user help
The ace-user help command provides a brief summary of available subcommands.
Example:
Command: ace-user help Return: Legal commands are: health: display health summary - ace-user health [-v] help: display command list install-layout: install a layout - ace-user install-layout repository layout load: install default load on Target status: display status of Target ace-user install-layout
The ace-user install-layout command is used to request the specified layout, which is loaded from the specified project.
Example:
The install-layout command is used to install the layout from the project. Command: ace-user install-layout <Project name> <Layout name> Return: Layout installed on localhost ace-user load
The ace-user load command is used to load the default project and layout. If no default project is configured, the current project is reloaded.
Example:
The load command used to load the default project and layout. Command: ace-user load Return: Load installed on localhost ace-user status
The ace-user status command is used to display the current status of the Target.
Example:
The following command is used to display current status. Command: ace-user status Return: [Workload] Default: radio_target1 InUse: radio_target1 Running: True Status: ['https://ace-target.local/projects/Prod_Radios', 'default', 'radio_target1', True, 1241550496] [Repository] URL: https://ace-target.local/projects/Prod_Radios ace-user start
The ace-user start command is used to start the default load.
Example:
The following command is used to start the default load. Command: ace-user start Return: Load started. ace-user stop
The ace-user stop command is used to stop the load.
Example:
The following command is used to stop the load. Command: ace-user stop Return: Load stopped. ace-user reboot
The ace-user reboot command is used to reboot the Target.
Example:
The following command is used to reboot the Target. Command: ace-user reboot Return: The system is going down for reboot NOW! Rebooting target... ace-user shutdown
The ace-user shutdown command is used to shutdown the Target.
Example:
The following command is used to shutdown the Target. Command: ace-user shutdown Return: The system is going down for system halt NOW! Shutting down target... |
|
| HomeStoreNewsProductsPricingSupportInstallationsCorporateContact ASTi | |
| Copyright 1997-2012 ASTi | Legal Stuff | |