Appendix D. Detailed Command Information - Symmetricom ATS-6511A User Manual

Appendix D. Detailed Command Information

The commands are listed alphabetically. Each command is listed with an explanation of what it
does along with examples. All of the commands are case sensitive. The system will inform the
operator that the commands were executed by returning an "OK" or other language denoting the
command has been accepted. Operators will be informed if the system cannot recognize the
command or syntax that was entered. In such cases where the data value entered is out of range
or is incorrect the ATS-6511 will generate an error message and will leave the current operating
value for that parameter unchanged and provide the operator with the acceptable range of values.
The system will recognize alphanumeric characters as well as the dash (-), single quotes '', and
the underscore '_' when attempting to save user configuration files. Use of any other characters
is prohibited and strictly enforced and the user will be informed they attempted to use an illegal
filename.
If the system cannot recognize the configuration, status, network or settings parameter the
operator is requesting it may return "no info". Make sure the fields were typed correctly for the
data you are attempting to retrieve.
Command Arguments:
[ ] Any arguments contained are optional and can be left out if desired.
•
< > Any arguments used with command.
•
| is used to separate alternative inputs for a single parameter (e.g., On/Off, 1/0)
•
Alarm:
Description:Displays the current alarm state of the instrument. Equivalent to issuing the status
alarm command. The returned alarm information provides the most significant alarm condition
that is currently active. It does not necessarily indicate all alarm conditions which are currently
present. For that purpose, health nodes are used to monitor the current state of the instrument and
raise alarms when the specified condition is detected. The health nodes themselves are part of the
status tree and can be viewed by typing status health at the command prompt.
Once a health node alarm is triggered it will produce one of two types of alarms:
Event alarm: Used to indicate alarms that have occurred but do not have a
•
persistent state. These alarms are latched and will remain active until the user
clears them with the clear_alarms command. Such an alarm might be triggered by
the loss of an external reference because even though the unit may switch to its
internal reference and continue to operate, the event is significant and warrants the
attention of the user.
State alarm: Used to indicate alarms that represent the current state of the
•
instrument.
instrument has returned to normal operating conditions. Such an alarm might be
triggered by an over temperature event in which the unit has detected elevated
These alarms remain active until the issue is resolved and the
80
DOC 6511_Release K
ATS-6511A/B/C Users Guide