Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

In this section

Table of Contents
maxLevel3

 


TL1 input commands have the following syntax:

...

Div
classpdf8pttext


Caption
0Table
1TL1 Input Command Syntax Elements and Examples
3InputTable


Syntax element Definition Syntax Example (in Bold)
<Verb>

The verb defines the type of action to be applied by the command to a network element. The verbs used with the

Spacevars
0company
Signaling System are as follows:

  • ADD - adds an network object
  • CHG - changes a network object
  • DLT - deletes a network object
  • SET - sets a network object
  • UNLOCK - unlocks a network object
  •  FORCELOCK - releases and   acquires a lock from a network   object filtering table that is owned by   another session. 
  • VFY - verifies a network objects 

Note:

For filtered network objects, it is recommended to use the UNLOCK command first to ensure subsequent commands will execute. This action releases the Network Object Filtering Table for the current session when it is locked by another user.

VFY-BRD-SER::6:;

Verify (VFY) specifies the action of the command.

<Modifier1> -<Modifier2>

The modifiers define the nature of the network object. There can be up to two modifiers for a command.

VFY-BRD-SER;

In this case the action is to verify the attributes configured for serial (SER) cards (BRD) attached to a

Spacevars
0company
Signaling System.

TID
Each
Spacevars
0company
Signaling System can have network management cards that provide network management interfaces. Each management interface is given a Host Name called a Source Identifier (SID) 1. The SID consists of the name of the management card and the chassis slot number for the card. The Target Identifier (TID) in a TL1 command specifies the SID of a network management interface for appropriate command routing and processing. The TID is not used in the input command, but it is displayed in the response.
Not used.
[AID] The Access Identifier (AID) specifies the equipment or utility that the command accesses. Some commands have an implied AID and do not require the AID to be entered, however, all commands use the AID attribute.

VFY-BRD-SER::6:;

The command is sent to a specific serial card in the 6th slot of the

Spacevars
0company
Signaling System chassis.

Empty tokens within an AID must be with double quotation marks.

PTI_TL1> VFY-DSC-RLMRTREC::8-RR-""-sonusnet:S;

The command is sent using the null parameter in place of the optional AID attribute. A syntax error occurs if the null parameter is not specified.

All: If no AID is specified for verify (VFY) commands, all available AIDs and attributes associated with each AID are listed. 2

VFY-BRD-SER;  

This command identifies the configuration attributes for all serial cards on a

Spacevars
0company
Signaling System system since no specific AID was entered.

Note:

Any attribute that contains TL1 special characters [ equal signs ( = ), colons ( : ), dashes ( - ), and commas ( , ) ] should be enclosed in double quotes ( " ) to help the attribute values escape. See the following example:

ADD-DSC-ALLOWIP::1-mlvmw.sonus.com-1-TCP-10.91.3.100-38680-"fe80::20c:29ff:fe8e:11b7:1:1"-52000:ctag;

 


[CTAG] The Correlation Tag (CTAG) specifies a command specific alphanumeric code that can be entered into the input command. The command response has the same CTAG in the response syntax. This provides a method to associate the input command with the output response.

VFY-BRD-SER::6:abCD123;

The entered CTAG appears in the response message.

[General Block]

The General Block contains all configurable attributes associated with the TL1 command verb, modifiers, and the AID. As a general rule, there are two types of attributes:

  • Named attributes : Each attribute value is preceded by the attribute name followed by the equal sign (=). Each used attribute is separated by a comma (,).
  • Unnamed attributes : The attribute value is identified by its position in the command and is not preceded by an attribute name and equal sign.

An attribute may be optional for a command and does not have to be specified. An object may have optionable, creatable attributes of type string, which can be omitted from the command when creating the object. The interface will assign the default empty string value to the attribute.

Note:

Any attribute that contains TL1 special characters [ equal signs ( = ), colons ( : ), dashes ( - ), and commas ( , ) ] should be enclosed in double quotes ( " ) to help the attribute values escape. See the following examples:

CHG-NA::1:s:::::CLLI="NA,1",ROTATESLS=ENABLED;

CHG-NA::1:s:::::CLLI="NA=1",ROTATESLS=ENABLED;

 


Named attribute example: CHG-ATM-LINKMGR::1:::::: DEBUG=DISABLED;

Unnamed attribute example: SET-ATM-LINKMGR::1:::: DEACT;

Optional ‘host = y’ attribute example:

Name = x, host = y; Name = x;

Optional attribute example: instead of:

ADD-DSC-NODE::5-"":S :::::REALM=pt.com,DID_HOST =hh,NAME=;

a short form can be used:

ADD-DSC-NODE::5:S :::::REALM=pt.com,DID_HOST =hh;




Info

1 The SID cannot be configured using TL1. Configure the SID using the Web UI.

2 If no TID, AID, CTAG, or attributes are specified, colons (:) do not need to be entered after the verb and modifiers. The semi colon (;) can be entered.

...

Peer ID - Position 1
Type: int
Description: Peer Identifier from LDL configuration.pagebreak


Connection ID - Position 2
Type: int
Description: Unique User Connection identifier for this peer ID.

...

  • <searchedAttrKey(x)> is a search attribute keyword that is returned in the output response format.
  • <Value(x)> is the value of the attribute.

...

Code Block
languagenone
::[<MTP3 NA/Network Appearance>]-[<VNode/VPC>]:<CLLI=string>,<DESC=string>,<STATE=ActivationState>,<TFA=Feature>,<TFP=Feature>,<TFR=Feature>,<MATE_DIST=Feature>;

...


For comparison, the VFY-VND command is specified without a search attribute:
...
 Div
classpdf8pttext

 Caption
0Table
1GWST Wildcard and Ranging Usage Rules

Usage Context            Definition                                                 Syntax Example (in Bold)
Wildcard for integers
When the wildcard is applied to a single integer value, all values within the possible range is indicated.
 

ADD-GWST-ACCMTP3 ::H2:s:::::NA=7,APC=005.005.005,DIRECTION=TX,OPC_RANGE=1.2.3,DPC_RANGE=1.3.4,SI_RANGE=*;
The possible range of values for SI_RANGE is 0 to 15. Using the * symbol specifies all values in this range.
Ranging for integersWhen ranging is applied to a single integer value, a subset of the values within the possible range is indicated.
ADD-GWST-ACCMTP3 ::H2:s:::::NA=7,APC=005.005.005,DIRECTION=TX,OPC_RANGE=1.2.3,DPC_RANGE=1.3.4,SI_RANGE=0&&12;
The possible range of values for SI_RANGE is 0 to 15. Using the && symbol specifies that the range 0 to 12 is used
Wildcard for point codes
When a wildcard symbol is used in a point code, the * symbol can be applied to one or all of the PC values. If the wildcard is applied to the network or cluster portion of the PC for ANSI, or the zone or area portion of the PC for ITU, the remaining portion(s) of the PC must use the wildcard symbol.
PC validation applies according to supported ITU and ANSI PC formation standards.
ADD-GWST-ACCMTP3 ::H2:s:::::NA=7,APC=005.005.005,DIRECTION=TX,
OPC_RANGE=1.2.*,
DPC_RANGE=1.*.*,SI_RANGE=0&&12;
Assuming the PC format for the example above is ANSI, the possible range of values for the member portion of the OPC_RANGE is 0 to 255. Using the * symbol indicates all values in the member portion of the PC.
The same applies to the DPC_RANGE where the wildcard value is used for the cluster and the member portions of the PC.
Ranging for point codes
When ranging is used in a point code (PC), ranging applies to the PC portion immediately before the ranging symbol. Only one range can be specified within a PC. If the range is applied to the network or cluster portion of the PC for ANSI, or the zone or area portion of the PC for ITU, the remaining portion(s) of the PC must use the wildcard “*” symbol.
PC validation applies according to supported ITU and ANSI PC formation standards.
ADD-GWST-ACCMTP3 ::H2:s:::::NA=7,APC=005.005.005,DIRECTION=TX,
OPC_RANGE=1.2.1&&15,
DPC_RANGE=1.25&&30.*,SI_RANGE=0&&12;
Assuming the PC format for the example above is ANSI, the possible range of values for the member portion of the OPC_RANGE is 0 to 255. Using the ranging symbol in the member portion of the PC indicates the range 1 to 15 for the given network, and cluster values.
The DPC_RANGE indicates a range of 25 to 30 in the cluster portion of the PC along with the wildcard symbol specifying all member values associated with the cluster range for the network with the value of 1.


Changing Incoming Linksets Using a TL1 Command
When making changes to an incoming Linkset using a TL1 command, do not use any leading zero’s (0s) in the Point Code. For example, a Point Code is added as 004.004.004 for an Incoming Linkset, but to modify the entry you must enter 4.4.4.pagebreak