2. Using the Command Line Interface
4200-A2-GB20-00 August 2002
2-3
Parameters
Parameters are values which clarify the function of a command. Parameter syntax
must be followed exactly to avoid system error responses. There are two types of
parameters:
Staging parameters
−
Designate where the verb of the command conducts
its operation (address). There are three unique addressing parameters:
— Target IDentification (TID)
−
Identifies the Network Element (NE) to which
the command is directed. Each NE in the system should have its own TID
code.
— Access IDentification (AID)
−
Gives the location of the network entity (such
as specific facilities and equipment) to which the command is directed.
When accessing multiple records, grouping and ranging of parameters
may be allowed. An example if grouping is in the command
RTRV-EQPT::LT-1-1-4<-1-1-5<-1-1-6
; where units
-4, -5,
and
-6
are requested. Note that the group must be specified for each item
entered. An example of ranging is in the command
RTRV-EQPT::LT-1-1-4&&-6
; where
-4&&-6
requests units 4 through
6. The ampersand (&) separates descriptive records, groups, and
members within an AID.
— Correlation TAG (CTAG)
−
Correlates the response message to the input
command. A response to a command echoes the appropriate CTAG. This
field is optional and can be any valid value or blank. The CLI automatically
fills in
100
(see
Command Entry Features
on page 2-4).
Data parameters
−
Provide specific data that may either be required or
optional. For example, in the command SET-DAT, the date and time are data
parameters (see
SET-DAT
in Chapter 14,
System Commands
for more
information).
Output Messages
Output messages are either the result of an input command or an event that
occurred in an NE, or are autonomous. The response message can be either
normal or an error report (see Appendix A,
Error Codes
). Those messages that
are not a response to an input command are classified as autonomous.
