- Preface
- Cisco ONS Documentation Roadmap for Release 9.6.x
- Chapter 1, ACT Commands
- Chapter 2, ALW Commands
- Chapter 3, Apply Commands
- Chapter 4, CANC Commands and Messages
- Chapter 5, CHG Commands
- Chapter 6, CLR Commands
- Chapter 7, CONN Commands
- Chapter 8, COPY Commands
- Chapter 9, DISC Commands
- Chapter 10, DLT Commands
- Chapter 11, ED Commands
- Chapter 12, ENT Commands
- Chapter 13, EX Commands
- Chapter 14, INH Commands
- Chapter 15, INIT Commands
- Chapter 16, OPR Commands
- Chapter 17, REPT Messages
- Chapter 18, RLS Commands
- Chapter 19, RMV Commands
- Chapter 20, RST Commands
- Chapter 21, RTRV Commands
- Chapter 22, SCHED Commands
- Chapter 23, SET Commands
- Chapter 24, SW Commands
- Chapter 25, TST Commands
- Chapter 26, Access Identifiers
- Chapter 27, Conditions
- Chapter 28, Modifiers
SET Commands
This chapter provides set (SET) commands for the Cisco ONS 15454, Cisco ONS 15454 M2, and Cisco ONS 15454 M6.
Note
All commands supported on the Cisco ONS 15454 platform are also supported on Cisco ONS 15454 M2 and Cisco ONS 15454 M6 platforms.
23.1 SET-ALMTH-<MOD2>
( Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Alarm Threshold for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 4GFC, 2GFICON, 5GIB, 8GFC, CLNT, D1VIDEO, DS1, DV6000, DVBASI, EC1, ESCON, ETRCLO, ETH, FSTE, GIGE, HDTV, ISC1, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OC768, OCH, OMS, OTS, OTU3, T1, T3, OTL, OTU1, OTU2, OTU4, SDSDI, HDSDI, 3GVIDEO, ISC3STP1G, and ISC3STP2G (SET-ALMTH-<MOD2>) c ommand sets the alarm thresholds on the following cards/ports/channels: MXP_2.5G_10G, TXP_MR_10G, optical service channel (OSC), optical amplifier, dispersion compensation unit (DCU), multiplexer, demultiplexer, and optical add/drop multiplexing (OADM).
Usage Guidelines
- This command is used to set the alarm thresholds on a facilities, ports, channels, for example. Not all MOD2 types are supported.
- This command supports the modifier OTU1, SDSDI, HDSDI, 3GVIDEO, ISC3STP1G, and ISC3STP2G.
- Tx alarm thresholds is blocked on Rx Video pluggables and vice-versa.
- Tx alarm thresholds is not applicable on ESCON payload.
- The SET-ALMTH-OTL is denied on backplane virtual ports of 100G-LC-C.
- The SET-ALMTH-OTL is denied on sublanes of CFP-LC but sets the alarms thresholds on first sublane of 100G-LC-C card.
- SET-ALMTH-<MOD2> on 100G-LC-C, 10x10G-LC, and CFP-LC cards use MOD2, and the following AID:
–
OCH modifier (CHAN AID) for non-OTU payloads on 100G-LC-C and 10x10G-LC fixed trunk ports.
–
MOD2 modifier on the OTU payloads of 10x10G-LC card on the VFAC AID.
–
OCH modifier (ACHAN AID) on the non-OTU payloads of the 100G-LC-C aggregate port.
–
MOD2 modifier (VLINE AID) on the first sublane of the 100G-LC-C card.
–
OCH modifier (CHAN AID) on the CFP-LC ports.
–
Alarm threshold cannot be set on the sublanes (VLINE) of the CFP-LC cards.
Category
Security
Input Format
SET-ALMTH-<MOD2>:[<TID>]:<AID>:<CTAG>::<CONDTYPE>,<THLEV>[,,,];
Input Example
Input Parameters
Access identifier from the “ALL” section. Must not be null. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier. |
|
Condition type for an alarm or a reported event. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. |
|
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm. |
|
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm. |
|
Laser Bias current in microA as one tenth of a percentage. High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent) |
|
Receive power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Receive power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Transmit power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Transmit power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm. |
|
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm. |
|
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm. |
|
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm. |
|
23.2 SET-ALMTH-EQPT
( Cisco ONS 15454) The Set Alarm Threshold Equipment (SET-ALMTH-EQPT) command sets the alarm thresholds to manage the power level monitoring on an NE.
Usage Guidelines
Category
Security
Input Format
SET-ALMTH-EQPT:[<TID>]:[<AID>]:<CTAG>::<ALMTHTYPE>,<THLEV>[,,,];
Input Example
Input Parameters
The node or shelf access identifier from the “SHELF” section. If omitted it addresses the node or first shelf of the node. Must not be null |
|
Alarm threshold type. The parameter type is ALM_THR, which is the alarm threshold list for MXP_2.5G_10G, TXP_MR_10G, OSCM, OSC-CSM, OPT-PRE, OPT-BST, MD-4, MUX-32, DMX-32, AD-1C, AD-2C, AD-4C, AD-1B, and AD-4B cards. |
|
Low Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm. |
|
High Threshold value for Chromatic Dispersion. Measured value -70000dBm to +70000dBm. |
|
Laser Bias current in microA as one tenth of a percentage High Warning Threshold, Low Warning Threshold. Measured value (0.0 percent, 100.0 percent) |
|
Receive power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Receive power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Transmit power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Transmit power in one tenth of a microW. Measured value (–40.0 dBm, +30.0 dBm) |
|
Low Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm. |
|
High Threshold value for Optical Signal to Noise Ratio. Measured value +40dBm to +80dBm. |
|
Low Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm. |
|
High Threshold value for Polarization Mode for Dispersion. Measured value +0 to +100dBm. |
|
23.3 SET-ATTR-CONT
( Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Attribute Control (SET-ATTR-CONT) command sets the attributes associated with an external control. The attributes are used when an external control is operated or released. To send the attributes, use the RTRV-ATTR-CONT command.
Usage Guidelines
Category
Security
Input Format
Input Example
Input Parameters
Access identifier from the “ENV” section. Identifies the external control for which attributes are being retrieved. |
|
Environmental control type. A null value is equivalent to ALL. The parameter type is CONTTYPE, which is the environmental control type. |
|
23.4 SET-ATTR-ENV
( Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Attribute Environment (SET-ATTR-ENV) command sets the attributes associated with an external control.
Usage Guidelines
- If the NTFCNCDE, ALMTYPE, and ALMMSG parameters are omitted, the environmental alarm specified by AID is unprovisioned.
- An alarm should be unprovisioned and you should wait for any raised alarm to clear before reprovisioning the alarm to another alarm type.
- CL in NOTIF_CODE is not valid for provisioning commands. It is only valid for autonomous messages.
Category
Security
Input Format
SET-ATTR-ENV:[<TID>]:<AID>:<CTAG>::[<NTFCNCDE>],[<ALMTYPE>],[<ALMMSG>];
Input Example
Input Parameters
Access identifier from the “ENV” section. Must not be null. |
|
Two-letter notification code. Must not be null. The parameter type is NOTIF_CODE, which is the two-character notification code associated with an autonomous message. |
|
The alarm type for the environmental alarm. Must not be null. The parameter type is ENV_ALM, which is the environmental alarm type. |
|
Explosive gas, toxic gas, ventilation fail, or gas monitor fail |
|
23.5 SET-ATTR-SECUDFLT
( Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Attribute Security Default (SET-ATTR-SECUDFLT) command sets the system-wide default values associated with several security parameters.
Usage Guidelines
- The following parameters are set on a system-wide basis for all users and all privilege levels: MXINV, DURAL, UOUT, PFRCD, POLD, PINT, and LOGIN. The PRIVLVL keyword cannot be used to set these parameters for a specific privilege level.
- The following parameters are set on a privilege-level basis: PAGE, PCND, and TMOUT. If any of these values are specified, the PRIVLVL keyword must also be present. If none of these parameters are specified, the PRIVLVL keyword cannot be used.
Note
Password aging can only be enabled/disabled for all privilege levels. The PRIVLVL keyword cannot be used with PAGE=0 to disable a specific user privilege level.
- When system-level and privilege-level keywords are combined in the same command, system-level parameters are still set for all privilege levels, regardless of the value specified by PRIVLVL. Privilege-level parameters are only set for the privilege level specified by PRIVLVL.
Note
If PAGE and PINT both have values greater than 0, PINT must be less than PAGE.
The order of keywords is not restricted. Commas are only needed to separate keywords. If no keywords are specified, all parameters are left as-is.
Category
Security
Input Format
SET-ATTR-SECUDFLT:[<TID>]::<CTAG>::[PAGE=<PAGE>],[PCND=<PCND>],[MXINV=<MXINV>],[DURAL=<DURAL>],[TMOUT=<TMOUT>],[UOUT=<UOUT>],[PFRCD=<PFRCD>],[POLD=<POLD>],[PINT=<PINT>],[LOGIN=<LOGIN>],[PRIVLVL=<UAP>],[PDIF=<PDIF>],[PWDCHRULE=<PWDCHRULE>],[PWDMINLEN=<PWDMINLEN>],[PWDMAXLEN=<PWDMAXLEN>];
Input Example
SET-ATTR-SECUDFLT:CISCO::123::PAGE=45,PCND=5,MXINV=5,DURAL=30,
TMOUT=0,UOUT=20,PFRCD=NO,POLD=5,PINT=20,LOGIN=MULTIPLE,
PRIVLVL=RTRV,PDIF=1;
SET-ATTR-SECUDFLT:::1::PWDCHRULE=ANY_CHAR,PWDMINLEN=2,PWDMAXLEN=20;
Input Parameters
23.6 SET-HOP-CPS
( Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set HOP Control Plane Service (SET-HOP-CPS) command is used to add, remove and modify an HOP route contraint of a Control Plane Service.
Usage Guidelines
- Specify only the source port to identify the CPS.
- Specify both the source AIDs, if the CPS is of type ADD 2WAY.
- CLIENT cps type support FAC and VFAC AID type.
- TRUNK cps type support CHAN AID type.
- ADD cps type support CHAN, PCHAN, and LINEWL AID type.
- In case of 1WAY, unidirectional connection, SRC and DST are single AIDs. In case of 2WAY, bidirectional connection, SRC and DST are double AIDs. However, in case of CLIENT or TRUNK cpstype, src and dst are single AID and the connection is of type 2WAY because of bidirectional ports hence this rule is not applicable.
Category
Security
Input Format
SET-HOP-CPS:[<TID>]:<SRC>:<CTAG>::<CIRCUITTYPE>,<ROUTETYPE>,<HOPACTION>,[<POSITION>],<HOPTYPE>,<HOPNODE>,[<HOPSIDE>][::];
Input Example
SET-HOP-CPS::VFAC-1-5-2:8::PRIMARY,MAINROUTE,ADD,,LOOSE,10.20.33.44;
Input Parameters
Source AID from the “CrossConnectId1” section. |
|
Identifies the target circuit. Allowed values are PRIMARY, SECONDARY. |
|
Identifies the target circuit route. Allowed values are MAINROUTE, BRIDGEROUTE. |
|
Identifies the action to perform on the hop item. Allowed values are ADD, REMOVE, MODIFY, CLEARALL |
|
Identifies the position of the hop in the item list. Default value is 0.
|
|
Type of hop constraint. Allowed values are STRICT, LOOSE, EXCLUDE |
|
23.7 SET-OPMOD-PTSYS
(Cisco ONS 15454) The Set Operation Mode Packet Transport System (SET-OPMOD-PTSYS) sets the operation mode for the CPT 50 panel.
Usage Guidelines
Category
Security
Input Format
SET-OPMOD-PTSYS:[<TID>]:<AID>:<CTAG>:::<OPMODE>,[RETAINDB=<RETAINDB>];
Input Example
Input Parameters
23.8 SET-PMMODE-<STS_PATH>
(Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Performance Mode of PM Data Collection for STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, or STS9C (SET-PMMODE-<STS_PATH>) command sets the mode and turns the performance monitoring (PM) data collection mode on or off.
Usage Guidelines
See Table 28-1 for supported modifiers by platform.
Note ●
The PM mode and state of an entity are retrieved by using the RTRV-PMMODE command.
- The near-end monitoring of the intermediate-path performance monitoring (IPPM) only supports OC3, OC12, OC48, OC192, and EC-1 on STS Path.
- The far-end IPPM data collection is supported by MRC-12 and ADM-10G cards only.
- This release of software will support only the Path (P) mode type PM parameters with this command, that is, this command is not applicable for Line (L) and Section (S) mode types. PM monitoring for Line (L) and Section (S) are supported by the ONS 15454, and the storing PM data is always performed.
Category
Security
Input Format
SET-PMMODE-<STS_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>,<MODETYPE>,
[<PMSTATE>];
Input Example
Input Parameters
Source access identifier from the “CrossConnectId” section. |
|
Location associated with a particular command. Identifies the location from which the PM mode is to be retrieved. Only near-end PM data collection is supported. The parameter type is LOCATION, which is the location where the action is to take place. |
|
The type of PM parameters that the entity or the sub entity is to store as a result of an attribute change. Only the path (P) PM parameter is supported. The parameter type is PM_MODE, which is the type of PM parameter. |
|
Directs the named PM mode type to turn on or off. A null value defaults to on. The parameter type is PM_STATE, which directs the named PM mode type (P) state. |
|
23.9 SET-PMMODE-<VT_PATH>
The Set Performance Mode of PM Data Collection for VT1 and VT2 (SET-PMMODE-<VT_PATH>) command sets the mode and turns the performance monitoring (PM) data collection mode on or off.
Usage Guidelines
Category
Security
Input Format
SET-PMMODE-<VT_PATH>:[<TID>]:<SRC>:<CTAG>::<LOCN>,<MODETYPE>,[<PMSTATE>];
Input Example
Input Parameters
Source access identifier from the “CrossConnectId1” section. Must not be null. |
|
Location associated with a particular command. Identifies the location from which the PM mode is to be set. Only near end (NEND)PM data collection is supported. The parameter type is LOCATION, which is the location where the action is to take place. Must not be null. |
|
The type of PM parameters that the entity or the subentity is to store as a result of an attribute change. Only the path (P) type is supported. The parameter type is PM_MODE, which is the type of PM parameters. |
|
Directs the named PM mode type to turn on or off. A null value defaults to on. The parameter type is PM_STATE, which directs the named PM mode type (P) state. |
|
23.10 SET-SRVTYPE
(Cisco ONS 15454 M2 and Cisco ONS 15454 M6) The Set Service Type (SET-SRVTYPE) command allows you to set the service type in the TNC card to carry User Data Channel (UDC) or voice over IP (VOIP) traffic.
Usage Guidelines
- You can configure UDC or VoIP on the two SFP ports present on the TNC card. The TNC card supports the UDC/VoIP configuration only when OSC is provisioned on the SFP ports.
- You can configure UDC or VoIP on only one SFP port at a time per TNC card. If you want to configure UDC or VoIP on the second SFP port, set NONE for the first port and then set UDC or VoIP for the second port.
Category
Security
Input Format
Input Example
Input Parameters
23.11 SET-TH-<MOD2>
(Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Threshold for 10GFC, 10GIGE, 40GIGE, 100GIGE, 1GFC, 1GFICON, 2GFC, 4GFC, 2GFICON, 5GIB, 8GFC, CLNT, D1VIDEO, DS1, DS3I, DV6000, DVBASI, E1, E3, E4, EC1, ESCON, ETRCLO, FSTE, G1000, GFPOS, GIGE, HDTV, ISC1, ISCCOMPAT, ISC3PEER2R, ISC3PEER1G, ISC3PEER2G, OC12, OC192, OC3, OC48, OC768, OCH, OMS, OTS, OTU3, POS, STM1E, STS1, STS12C, STS18C, STS192C, STS24C, STS36C, STS3C, STS48C, STS96C, STS6C, STS9C, T1, T3, VC11, VC12, VC3, VT1, VT2, OTL, OTU1, OTU2, OTU4, SDSDI, HDSDI, 3GVIDEO, ISC3STP1G, or ISC3STP2G (SET-TH-<MOD2>) command sets the threshold for PMs and sets the alarm thresholds for the MXP_2.5G_10G and TXP_MR_10G cards. If this command is used to set the alarm thresholds on, the time period is not applicable. This command sets alarm thresholds on AR-MXP, AR-XP, and AR-XPE cards and ports, and optical add/drop multiplexing (OADM).
Usage Guidelines
The command supports the modifier OTU1, SDSDI, HDSDI, 3GVIDEO, ISC3STP1G, and ISC3STP2G.
See Table 28-1 for supported modifiers by platform.
The Tx power is blocked on Rx Video pluggables and vice-versa. The Tx power is not applicable on ESCON payload.
- The PM Thresholds have a default of NEND for the location. The Alarm Thresholds do not require or interpret the location.
- The TMPER is not applicable to alarm thresholds. The TMPER default is 15-MIN.
- The client ports only accept SONET, Laser, and alarm MONTYPEs. The trunk ports accept SONET, Laser, alarm, FEC, OTN, and 8B10B MONTYPEs.
- The SET-TH-OTL is denied on backplane virtual ports of 100G-LC-C for optical thresholds only.
- The SET-TH-OTL is denied on sublanes of CFP-LC. The command sets the alarms thresholds on first sublane of 100G-LC-C card.
- The SET-TH-<MOD2> on 100G-LC-C, 10x10G-LC, and CFP-LC ports use MOD2 and the following AID:
–
OCH (CHAN AID for non-OTU payloads on 100G-LC-C, 10x10G-LC, and CFP-LC fixed trunk ports. ACHAN for non-OTU payloads on the 100G-LC-C card using the CXP pluggable).
–
MOD2 (VFAC AID for OTU payloads on 10x10G-LC and CFP-LC ports. ACHAN for OTU payloads on the 100G-LC-C card using the CXP pluggable).
–
TCA threshold cannot be set on sublanes (VLINE) of CFP-LC cards.
Category
Security
Input Format
SET-TH-<MOD2>:[<TID>]:<AID>:<CTAG>::<MONTYPE>,<THLEV>,[<LOCN>],,[<TMPER>];
Input Example
Input Parameters
Access identifier from the “ALL” section. All of the STS, VT1, Facility, and DS1 AIDs are supported. The AR-MXP, AR-XP, and AR-XPE cards use the VFAC Access Identifier. |
|
Monitored type. The parameter type is ALL_MONTYPE, which is the monitoring type list. |
|
OTN—Background Block Error Ratio—Path monitor point expressed as one tenth of a percentage |
|
OTN—Background Block Error Ratio—Section monitor point expressed as one tenth of a percentage |
|
Errored Seconds Ratio—Path monitor point expressed as one tenth of a percentage |
|
Errored Seconds Ratio—Section monitor point expressed as one tenth of a percentage |
|
The total number of good packets received that were directed to a multicast address |
|
The total number of packets received that have a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets |
|
The total number of packets received that were less than 64 octets |
|
The total number of packets received that are longer than 1518 octets |
|
The total number of packets received that are longer than 1518 octets |
|
The total number of packets (including bad packets, broadcast packets, and multicast packets) received |
|
The total number of packets received that are less than 64 octets |
|
The number of High-Order Path Severely Errored Period Intensity events in available time |
|
Number of broadcast packets received since the last counter reset |
|
The number of inbound packets (or transmission units) that contained errors |
|
Number of multicast packets received since the last counter reset |
|
Number of unicast packets received since the last counter reset |
|
The number of outbound packets (or transmission units) that could not be transmitted because of errors |
|
Normalized value for Optical Power Transmitted for the OC3-8 card |
|
Severely Errored Framing Seconds—Path (DS3XM-12 DS1 PM count) |
|
Severely Errored Second — Network Path (DS3XM-12 DS1 PM count) |
|
OTN—Severely Errored Second Ratio—Path Monitor Point expressed as one tenth of a percentage |
|
OTN—Severely Errored Second Ratio—Section Monitor Point expressed as one tenth of a percentage |
|
Location associated with a particular command. The parameter type is LOCATION, which is the location where the action is to take place. |
|
(Optional) Accumulation time period for performance counters. The parameter type is TMPER, which is the accumulation time period for the performance management center. |
|
Performance parameter accumulation interval length; every 24-hours. For SONET PM data, only one day of history data is available. For RMON managed PM data, seven days of history data are available. |
|
Performance parameter accumulation interval length; every 1 hour. This is only applicable to RMON managed PM data. There are 24 hours of history data available. |
|
Performance parameter accumulation interval length; every 1 minute. This is only applicable to RMON managed PM data. There are 60 minutes of history available. |
|
Performance parameter accumulation interval length; every 15 minutes. There are 32 15-MIN buckets of history data available for this accumulation interval length. |
|
Performance parameter accumulation interval length; starting from the last time the counters were cleared. This is only applicable to RMON managed PMs. |
23.12 SET-TOD
(Cisco ONS 15454, ONS 15454 M2, and ONS 15454 M6) The Set Time of Day (SET-TOD) command sets the system date and time for the NE. The year should be entered using four digits while the hour should be entered using a 24-hour time period (for example, military time).
Usage Guidelines
Category
Security
Input Format
SET-TOD:[<TID>]::<CTAG>::<YEAR>,<MONTH>,<DAY>,<HOUR>,<MINUTE>,<SECOND>,
[<DIFFERENCE>][:DST=<DST>];
Input Example
Input Parameters
Feedback