OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 1 of 243

Document code Product name OptiX OSN 3500&2500

Target readers Engineers Product version V100R001

Edited by Optical Network technical support department Document version

OptiX OSN3500&2500 V100R001 Nesoft

Configuration Command Line Reference

rafted by: OptiX OSN 3500 Nesoft Team Date: 2004-10-01

Reviewed by: Date:

Reviewed by: Date:

Approved by: Date:

Huawei Technologies Co, Ltd

All Rights Reserved

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 2 of 243

Revision Records
Date Revised version Description Author

2004-10-01 1.00

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 3 of 243

Contents
Chapter 1 Equipment Management
1.1 Network Element (NE) Properties Management
1.1.1 Initialize all the configuration data of the SCC board: cfg-init-all.
1.1.2 Initialize all the configuration data of the NE: cfg-init-ne
1.1.3 Set the device and subrack type: cfg-set-devicetype
1.1.4 Query the device and subrack type: cfg-get-devicetype
1.1.5 Set the NE name: cfg-set-nename
1.1.6 Query the NE name: cfg-get-nename
1.1.7 Set the NE position: cfg-set-neposition
1.1.8 Query the NE position: cfg-get-neposition
1.1.9 Set the NE memo information: cfg-set-nememo
1.1.10 Query the NE memo information: cfg-get-nememo
1.1.11 Query the NE running status: cfg-get-nestatus
1.1.12 Set the NE test switch status: cfg-set-test
1.1.13 Query the NE test switch status: cfg-get-test
1.1.14 Set the NE service mode: cfg-set-servicemode
1.1.15 Query the NE service mode: cfg-get-servicemode
1.1.16 Set the switch status of the NE configuration data consistency check: cfg-set-bdcheck
1.1.17 Query the switch status of the NE configuration data consistency check switch status: cfg-get-bdcheck
1.1.18 Set the period of the NE configuration data consistency check: cfg-set-bdchecktime
1.1.19 Query the period of the NE configuration data consistency: cfg-get-bdchecktime
1.1.20 Test command of the NE configuration data consistency check: cfg-test-bdcheck
1.1.21 Configuration check: cfg-verify
1.1.22 Set the switch status of the low service optimization: cfg-set-lxcoptmz
1.1.23 Query the switch status of the low service optimization: cfg-get-lxcoptmz
1.2 Basic Board Configuration Commands
1.2.1 Install the board: cfg-add-board
1.2.2 Install all boards: cfg-add-allbd
1.2.3 Delete the board: cfg-del-board
1.2.4 Query the installed logic boards in the subrack: cfg-get-board
1.2.5 Query the type of the inserted physical board in the subrack: cfg-get-phybd
1.2.6 Reset a board: cfg-reset-board
1.2.7 Set the alarm threshold for the board temperature: cfg-set-bdtempth
1.2.8 Query the alarm threshold of the board temperature: cfg-get-bdtempth
1.2.9 Query the board version information: cfg-get-bdversion
1.2.10 Query the detail board version information: cfg-get-bdverinfo
1.2.11 Set the board parameters: cfg-set-bddata
1.2.12 Save the board configuration data to the flash: cfg-backup-bdcfg
1.2.13 Clear the board configuration data in the flash: cfg-clear-bdcfg
1.2.14 Query the board configuration data backup: cfg-get-bdcfg
1.2.15 Set automatic clear: cfg-set-autoclear
1.2.16 Query the automatic clear: cfg-get-autoclear
1.2.17 Query the loop auto clear information of the Ethernet board: cfg-get-ethlooplist
1.2.18 Query the board working status: cfg-get-workstat
1.2.19 Set the FAN running mode: cfg-set-fanmode
1.2.20 Query the FAN running mode: cfg-get-fanmode
1.2.21 Set the FAN speed: cfg-set-fanspeed
1.2.22 Query the manually-set FAN speed: cfg-get-fanspeed
1.2.23 Query the current FAN information: cfg-get-fancurinfo
1.3 Common Configuration Commands for Service Boards
1.3.1 Set the AIS inserting status of the alarm event: cfg-set-alm2ais
1.3.2 Query the AIS inserting status of the alarm event: cfg-get-alm2ais
1.3.3 Set the transmission switch of the overhead byte: cfg-set-tohenable
1.3.4 Query the transmission switch of the overhead byte: cfg-get-tohenable
1.3.5 Set the port loop mode: cfg-set-loop
1.3.6 Query the port loop mode: cfg-get-loop
1.4 Commands for Configuring Line Board Properties
1.4.1 Set vc4 path loopback: cfg-set-vc4loop

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 4 of 243
1.4.2 Query the vc4 path loop mode: cfg-get-vc4loop
1.4.3 Set the laser switch status: cfg-set-laser
1.4.4 Query the laser switch status: cfg-get-laser
1.4.5 Set the ALS: cfg-set-als
1.4.6 Query the ALS status: cfg-get-als
1.4.7 Set the ALS time parameter: cfg-set-alstime
1.4.8 Query the ALS time parameter: cfg-get-alstime
1.4.9 Laser ALS constantly in the testing status: cfg-test-als
1.4.10 Set the thresholding-crossing and the degraded threshold of B1B2B3: cfg-set-b1b2b3th
1.4.11 Query the threshold-crossing and the degraded threshold of B1B2B3: cfg-get-b1b2b3th
1.4.12 Set the to-be-sent J0 bytes: cfg-set-stj0
1.4.13 Query the to-be-sent J0 bytes: cfg-get-stj0
1.4.14 Set the receivable J0 bytes: cfg-set-srj0
1.4.15 Query the receivable J0 bytes: cfg-get-srj0
1.4.16 Query the received J0 bytes: cfg-get-rj0
1.4.17 Set the to-be-sent J1 bytes: cfg-set-stj1
1.4.18 Query the to-be-sent J1 bytes: cfg-get-stj1
1.4.19 Set the receivable J1 byets:cfg-set-srj1
1.4.20 Query the receivable J0 bytes: cfg-get-srj1
1.4.21 Query the received J1 bytes: cfg-get-rj1
1.4.22 Set the to-be-sent J1 bytes (support AU3): cfg-set-stj1ex
1.4.23 Query the to-be-sent J1 bytes (support AU3): cfg-get-stj1ex
1.4.24 Set the receivable J1 bytes (support AU3): cfg-set-srj1ex
1.4.25 Query the receivable J1 bytes (suppot AU3): cfg-get-srj1ex
1.4.26 Query the received J1 bytes (support AU3): cfg-get-rj1ex
1.4.27 Set the monitoring status of the pass-through J1/C2 byte: cfg-set-j1c2monitor
1.4.28 Query the monitoring status of the pass-through J1/C2 byte: cfg-get-j1c2monitor
1.4.29 Set the to-be-sent C2 byte: cfg-set-stc2
1.4.30 Query the to-be-sent c2 byte: cfg-get-stc2
1.4.31 Set the receivable C2 byte: cfg-set-src2
1.4.32 Query the receivable C2 byte: cfg-get-src2
1.4.33 Query the received C2 byte: cfg-get-rc2
1.4.34 Set the to-be-sent C2 byte (support AU3): cfg-set-stc2ex
1.4.35 Query the to-be-sent C2 byte (support AU3): cfg-get-stc2ex
1.4.36 Set the receivable C2 byte (support AU3): cfg-set-src2ex
1.4.37 Query the receivable C2 byte (support AU3): cfg-get-src2ex
1.4.38 Query the received C2 byte (support AU3): cfg-get-rc2ex
1.4.39 Set the status of B2EXC and MSAIS (as the clock source switchover condition): cfg-set-alm2clksw
1.4.40 Query the status of B2EXC and MSAIS (as the clock source switchover condition): cfg-get-alm2clksw
1.4.41 Set the to-be-sent N1 bytes: cfg-set-stn1
1.4.42 Query the to-be-sent N1 bytes: cfg-get-stn1
1.4.43 Set the receivable N1 bytes: cfg-set-srn1
1.4.44 Query the receivable N1 bytes: cfg-get-srn1
1.4.45 Query the received N1 bytes: cfg-get-rn1
1.4.46 Set the to-be-sent N1 bytes (support AU3): cfg-set-stn1ex
1.4.47 Query the to-be-sent N1 bytes (support AU3): cfg-get-stn1ex
1.4.48 Set the receivable N1 bytes (support AU3): cfg-set-srn1ex
1.4.49 Query the receivable N1 bytes (support AU3): cfg-get-srn1ex
1.4.50 Query the received N1 bytes (support AU3): cfg-get-rn1ex
1.4.51 Set the overhead extraction function: cfg-set-rohdrop
1.4.52 Query the overhead extraction function: cfg-get-rohdrop
1.4.53 Set the status of TCM: cfg-set-tcm
1.4.54 Query the status of TCM: cfg-get-tcm
1.4.55 Set the status of TCM (support AU3): cfg-set-tcmex
1.4.56 Query the status of TCM (support AU3): cfg-get-tcmex
1.4.57 Set the AIS inserting status of TCM alarm event: cfg-set-tcalm2ais
1.4.58 Query the AIS inserting status of TCM alarm event: cfg-get-tcalm2ais
1.4.59 Set the hardware REG: cfg-set-hardreg
1.4.60 Query the hardware REG permission status: cfg-get-hardreg
1.4.61 Set the VC4 mode: cfg-set-vc4mode
1.4.62 Query the VC4 mode: cfg-get-vc4mode
1.5 Commands for Configuring Tributary board Properties
1.5.1 Set BIP threshold for the path bit error: cfg-set-bipth

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 5 of 243
1.5.2 Query the BIP threshold for the path bit error: cfg-get-bipth
1.5.3 Path bit error test: cfg-set-bittest
1.5.4 Set the UNEQ inserting status in the case of LOS or path not in use: cfg-set-almuneq
1.5.5 Query the UNEQ inserting status in the case of LOS or path not in use: cfg-get-almuneq
1.5.6 Query the impedance of the path cable: cfg-get-e1eq
1.5.7 Set the to-be-sent J2 bytes: cfg-set-stj2
1.5.8 Query the to-be-sent J2 bytes: cfg-get-stj2
1.5.9 Set the receivable J2 bytes: cfg-set-srj2
1.5.10 Query the receivable J2 bytes: cfg-get-srj2
1.5.11 Query the received J2 bytes: cfg-get-rj2
1.5.12 Set the to-be-sent V5 byte: cfg-set-stv5
1.5.13 Query the to-be-sent V5 byte: cfg-get-stv5
1.5.14 Set the receivable V5 byte: cfg-set-srv5
1.5.15 Query the receivable V5 byte: cfg-get-srv5
1.5.16 Query the received V5 byte: cfg-get-rv5
1.5.17 Set the status of path: cfg-set-pathused
1.5.18 Query the status of path: cfg-get-pathused
1.5.19 Set the path retiming clock: cfg-set-retiming
1.5.20 Query the path retiming clock: cfg-get-retiming
1.5.21 Set the path sending overhead: cfg-set-tpoh
1.5.22 Query the path sending overhead: cfg-get-tpoh
1.5.23 Query the path receiving overhead: cfg-get-rpoh
1.5.24 Set the path master downlink bus: cfg-set-defbus
1.5.25 Query the path master downlink bus: cfg-get-defbus
1.5.26 Query the path working downlink bus: cfg-get-dropbus
1.5.27 Set the reporting mode of the bus alarm: cfg-set-busalm
1.5.28 Query the reporting mode of the bus alarm: cfg-get-busalm
1.5.29 Set the to-be-sent J1 bytes of VC3: cfg-set-vc3stj1
1.5.30 Query the to-be-sent J1 bytes of VC3: cfg-get-vc3stj1
1.5.31 Set the receivable J1 bytes of VC3: cfg-set-vc3srj1
1.5.32 Query the receivable J1 bytes of VC3: cfg-get-vc3srj1
1.5.33 Query the received J1 bytes of VC3: cfg-get-vc3rj1
1.5.34 Set the to-be-sent C2 byte of VC3: cfg-set-vc3stc2
1.5.35 Query the to-be-sent C2 byte of VC3: cfg-get-vc3stc2
1.5.36 Set the receivable C2 byte of VC3: cfg-set-vc3src2
1.5.37 Query the receivable C2 byte of VC3: cfg-get-vc3src2
1.5.38 Query the received C2 byte of VC3: cfg-get-vc3rc2
1.5.39 Set the status of the input balance: cfg-set-selreqb
1.5.40 Query the status of the input balance: cfg-get-selreqb
1.5.41 Set the status of the output balance: cfg-set-selteqb
1.5.42 Query the status of the output balance: cfg-get-selteqb
1.5.43 Set the service type: cfg-set-payloadtype
1.5.44 Query the service type: cfg-get-payloadtype
1.5.45 Set the service matching of the tributary board path: cfg-set-tumatch
1.5.46 Query the service matching of the tributary board path: cfg-get-tumatch
1.6 Ethernet Boards Configuration Commands
1.6.1 Set the loop mode of the ethernet path: cfg-set-vcloop
1.6.2 Query the loop mode of the ethernet path: cfg-get-vcloop
1.6.3 Set the to-be-sent J1 bytes: cfg-set-vcstj1
1.6.4 Query the Ethernet to-be-sent J1 bytes: cfg-get-vcstj1
1.6.5 Set the ethernet receivable J1 bytes: cfg-set-vcsrj1
1.6.6 Query the ethernet receivable J1 bytes: cfg-get-vcsrj1
1.6.7 Query the ethernet received J1 bytes: cfg-get-vcrj1
1.6.8 Set the ethernet to-be-sent C2 byte: cfg-set-vcstc2
1.6.9 Query the ethernet to-be-sent C2 byte: cfg-get-vcstc2
1.6.10 Set the ethernet receivable C2 byte: cfg-set-vcsrc2
1.6.11 Query the ethernet receivable C2 byte: cfg-get-vcsrc2
1.6.12 Query the ethernet received C2 byte: cfg-get-vcsrc2
1.6.13 Set the ethernet to-be-sent J2 bytes: cfg-set-vcstj2
1.6.14 Query the ethernet to-be-sent J2 bytes: cfg-get-vcstj2
1.6.15 Set the ethernet receivable J2 bytes: cfg-set-vcsrj2
1.6.16 Query the ethernet receivable J2 bytes: cfg-get-vcsrj2
1.6.17 Query the ethernet received J2 bytes: cfg-get-vcrj2

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 6 of 243
1.6.18 Set the ethernet to-be-sent V5 bytes: cfg-set-vcstv5
1.6.19 Query the ethernet to-be-sent V5 bytes: cfg-get-vcstv5
1.6.20 Set the ethernet reveivable V5 bytes: cfg-set-vcsrv5
1.6.21 Query the ethernet reveivable V5 bytes: cfg-get-vcsrv5
1.6.22 Query the ethernet reveived V5 bytes: cfg-get-vcrv5
1.7 Commands for Configuring Clock Board Properties
1.7.1 Query the current tracing clock source: cfg-get-cursyn
1.7.2 Query the current 2M tracing clock source: cfg-get-2mcursyn
1.7.3 Query the current tracing source and the corresponding S1 bytes: cfg-get-cursyns1
1.7.4 Query the 2M current tracing source and the corresponding S1 bytes: cfg-get-2mcursyns1
1.7.5 Query the S1 bytes corresponding to all sources in the system priority list: cfg-get-alls1
1.7.6 Query the S1 bytes corresponding to all sources in the 2M priority list: cfg-get-2malls1
1.7.7 Query the currently existing sources in the priority list: cfg-get-synexist
1.7.8 Set the priority list of the system clock source: cfg-set-synclass
1.7.9 Set the clock source priority list of the 2M phase source: cfg-set-2msynclass
1.7.10 Query the clock source priority list: cfg-get-synclass
1.7.11 Query the clock source priority list of the 2M phase source: cfg-get-2msynclass
1.7.12 Execute the external switch and reset commands of the system clock priority list: cfg-set-synextsw
1.7.13 Execute the external switch and reset commands of the 2M clock priority list: cfg-set-2msynextsw
1.7.14 Query the switching status of the clock source in the system clock priority list: cfg-get-synswstatus
1.7.15 Query the switching status of the clock source in the 2M phase source priority list: cfg-get-2msynswstatus
1.7.16 Set the action for the 2M clock source failure: cfg-set-2mpllsynlosaction
1.7.17 Query the action for the 2M clock source failure: cfg-get-2mpllsynlosaction
1.7.18 Enable/Disable the configured clock source to be used in the switching: cfg-set-synenable
1.7.19 Query the status (enable/disable) of the configured clock source to be used in the switching: cfg-get-
synenable
1.7.20 Set the receiving time slot for the external source S1 byte: cfg-set-exts1inslot
1.7.21 Query the receiving TS of the external source S1 byte: cfg-get-exts1inslot
1.7.22 Set the output TS for the external source S1 byte: cfg-set-exts1outslot
1.7.23 Query the output TS of the external source S1 byte: cfg-get-exts1outslot
1.7.24 Enable/Disable switching in the sequence of descending priority: cfg-set-syncnorvt
1.7.25 Query the enabling status of switching the clock source in the sequence of descending priority: cfg-get-
syncnorvt
1.7.26 Set the data output mode in the Keep mode: cfg-set-synkeepmode
1.7.27 Query the data output mode in the Keep mode: cfg-get-synkeepmode
1.7.28 Set the working mode for the data output of the external source: cfg-set-outsynmode
1.7.29 Query the working mode of the data output of the external source: cfg-get-outsynmode
1.7.30 Set the data output threshold for the external source: cfg-set-outputth
1.7.31 Query the data output threshold of the external source: cfg-get-outputth
1.7.32 Set maunually the S1 byte clock quality: cfg-set-mans1qua
1.7.33 Query the S1 byte clock quality: cfg-get-mans1qua
1.7.34 Set the waiting time for the clock source recovery: cfg-set-synwtrtime
1.7.35 Query the waiting time for the clock source recovery: cfg-get-synwtrtime
1.7.36 Set ID for the S1 byte clock source: cfg-set-syns1id
1.7.37 Query the ID of the S1 byte clock source: cfg-get-syns1id
1.7.38 Set the input mode for the external source: cfg-set-insynmode
1.7.39 Query the input mode of the external source: cfg-get-insynmode
1.7.40 Set the SSM protocol mode for the S1 byte: cfg-set-s1mode
1.7.41 Query the SSM protocol mode of the S1 byte: cfg-get-s1mode
1.7.42 Permit/Forbid the optical interface corresponding to the clock source to output the S1 byte: cfg-set-
s1exportmode
1.7.43 Query the status of permitting/forbidding the optical interface corresponding to the clock source to output the
S1 byte: cfg-get-s1exportmode
1.7.44 Query the current working mode of the clock board: cfg-get-stgworkmode
1.7.45 Set the quality level represented by QL_UNKNOW: cfg-set-qlunknow
1.7.46 Query the quality level represented by QL_UNKNOW: cfg-get-qlunknow
1.7.47 Permit/Forbid the optical interface to output the clock ID: cfg-set-s1idexportmode
1.7.48 Query the status of permitting/forbidding the optical interface to output the clock ID: cfg-get-s1idexportmode
1.7.49 Enable/Disable the frequency deviation function of the clock source: cfg-set-synbaddetect
1.7.50 Query the status (enable/disable) of the frequency deviation function of the clock source: cfg-get-
synbaddetect
1.7.51 Set the condition for the external source failure: cfg-set-lapseterm
1.7.52 Query the condition for the external source failure: cfg-get-lapseterm

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 7 of 243
1.7.53 Query the working status and DA value of the current clock source: cfg-get-synstatusda
1.8 EOW Configuration Commands
1.8.1 Set the orderwire number: cfg-set-telnum
1.8.2 Query the orderwire number: cfg-get-telnum
1.8.3 Set the conference orderwire number for the whole network: cfg-set-meetnum
1.8.4 Query the conference orderwire number of the whole network: cfg-get-meetnum
1.8.5 Set the telephone number length: cfg-set-tellen
1.8.6 Query the telephone number length: cfg-get-tellen
1.8.7 Set the call waiting time: cfg-set-reqtime
1.8.8 Query the call waiting time: cfg-get-reqtime
1.8.9 Set the availability of the optical interface in the addressing call: cfg-set-lineused
1.8.10 Query the availability of the optical interface in the addressing call: cfg-get-lineused
1.8.11 Set the availability of the optical interface in the conference call: cfg-set-meetlineused
1.8.12 Query the availability of the optical interface in the conference call: cfg-get-meetlineused
1.8.13 Set the TS and broadcast source of the broadcast data port: cfg-set-dataport
1.8.14 Delete the configuration information of the broadcast data interface: cfg-del-dataport
1.8.15 Query the TS and source of the broadcast data interface: cfg-get-dataport
1.8.16 Set the multiplex port to the com port or the broadcast data port: cfg-set-porttype
1.8.17 Query the port type of the multiplex port: cfg-get-porttype
1.8.18 Set the electrical characteristics of the port: cfg-set-portmode
1.8.19 Query the electrical characteristics of the port: cfg-get-portmode
1.8.20 Set the F1 data port: cfg-set-f1port
1.8.21 Query the configuration of F1 data port: cfg-get-f1port
1.8.22 Delete the pass-through configuration of the F1 data port (See the ¡°Set the F1 data port¡± command)
1.8.23 Set the subnet number length: cfg-set-subnetlen
1.8.24 Query the subnet number length: cfg-get-subnetlen
1.8.25 Set the subnet number: cfg-set-subnetbd
1.8.26 Query the subnet number: cfg-get-subnetbd
1.8.27 Set the status (enable/disable) of the auto switch protection: cfg-set-autoswitch
1.8.28 Query the status (enable/disable) of the auto switch protection: cfg-get-autoswitch
1.8.29 Test the telephone ring: cfg-set-ringtest
1.8.30 Test the ring back tone: cfg-set-alerttest
1.8.31 Test the call dialing: cfg-set-dialnumtest
1.9 Commands for Configuring Optical amplifier board Properties
1.9.1 Open/Close the pump laser: cfg-set-pumplasersw
1.9.2 Query the status (open/close) of the pump laser: cfg-get-pumplasersw
1.9.3 Query the type of the optical amplifier board: cfg-get-oatype
1.9.4 Query the performance parameter list of the optical amplifier board: cfg-get-paralist
1.10 Alarm Bolean Management
1.10.1 Set the output status of the alarm relay switch: cfg-set-cskswitch
1.10.2 Query the output status of the alarm relay switch: cfg-get-cskswitch
1.10.3 Set the output status of the auxiliary function relay: cfg-set-extrelayuse
1.10.4 Query the output status of the auxiliary function relay: cfg-get-extrelayuse
1.10.5 Set the relay input mode: cfg-set-onerelayuse
1.10.6 Query the relay input mode: cfg-get-onerelayuse
1.11 Pluggable Laser Module Management
1.11.1 Query the laser module status: cfg-get-lsr-stat
1.11.2 Query the laser module sequence number: cfg-get-lsr-sn
1.11.3 Query the laser module speed: cfg-get-lsr-speed
1.11.4 Query the laser module transmission distance: cfg-get-lsr-distance
1.11.5 Query the laser module HWID: cfg-get-lsr-hwid
1.11.6 Set the HWID for the pluggable laser module: cfg-set-lsr-hwid
Chapter 2 Seveice and Protection
2.1 Report of Service and Protection Events
2.1.1 Report switchover events of the ring MS protection group
2.1.2 Report the switchover events of the liner MS protection group
2.1.3 Report the switchover events of the SNCP protection group
2.1.4 Report the switchover events of the TPS protection group
2.1.5 Report the status change events of the TPS protection board
2.1.6 Report the switchover events of the DPS protection group
2.2 Cross Connection Commands
2.2.1 Create the cross connection: cfg-add-xc
2.2.2 Delete the cross connection: cfg-del-xc

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 8 of 243
2.2.3 Query the cross connection: cfg-get-xc
2.2.4 Query the actual high order cross connection: cfg-get-xcconnect
2.2.5 Query the high order cross connection route: cfg-get-connect
2.2.6 Cross connection query conditions: cfg-get-condxc
2.2.7 Query the cross connection low order services: cfg-get-bdlowxc
2.3 Linear Multiplex Section Commands
2.3.1 Create a linear MSP Group: cfg-add-lmspg
2.3.2 Delete a linear MSP group: cfg-del-lmspg
2.3.3 Query all the linear MSP groups: cfg-get-lmspg
2.3.4 Set the waiting time for the linear MSP group recovery: cfg-set-lmsattrib
2.3.5 Query the waiting time for the linear MSP group recovery: cfg-get-lmsattrib
2.3.6 Set the signal degrading flag for the protection group: cfg-set-lmssdflag
2.3.7 Query the degrading flag of the protection group: cfg-get-lmssdflag
2.3.8 Set the port mapping relationship of the linear MS protection unit: cfg-set-lmsbdmap
2.3.9 Query the port mapping relationship of the linear MS protection unit: cfg-get-lmsbdmap
2.3.10 Start the linear MS protocol controller: cfg-start-lms
2.3.11 Stop the linear MS protocol controller: cfg-stop-lms
2.3.12 Initiate the external switchover command of the linear MSP group: cfg-set-lmsswitch
2.3.13 Query the switchover status of the linear MS protection group: cfg-get-lmsstate
2.3.14 Query the switchover event logs of the Linear MS protection group: cfg-get-lmsevent
2.3.15 Clear the switchover event logs of the linear MS protection group: cfg-init-lmsevent
2.3.16 Set the switchover holdoff time of the linear MS protection group: cfg-set-lmsholdofftime
2.3.17 Query the switchover holdoff time of the linear MS protection group: cfg-get-lmsholdofftime
2.3.18 Set the k2 mode of the linear MS protection group: cfg-set-lmsk2mode
2.3.19 Query the k2 mode of the linear MS protection group: cfg-get-lmsk2mode
2.3.20 Set the priority of the linear MS SF and SD in the K bytes: cfg-set-lmsklevel
2.3.21 Query the priority of the linear MS SF and SD in the K bytes: cfg-get-lmsklevel
2.4 Ring Multiplex Section Commands
2.4.1 Create a Ring MS protection group: cfg-add-rmspg
2.4.2 Delete a Ring MS protection group: cfg-del-rmspg
2.4.3 Query all the MS Ring protection groups: cfg-get-rmspg
2.4.4 Set the attributes of the MS ring protection group: cfg-set-rmsattrib
2.4.5 Query the attributes of the MS ring protection group: cfg-get-rmsattrib
2.4.6 Set the degrading flag of the MS ring protection group: cfg-set-rmssdflag
2.4.7 Query the degrading flag of the MS ring protection group: cfg-get-rmssdflag
2.4.8 Set the port mapping relationship of the MS ring protection unit: cfg-set-rmsbdmap
2.4.9 Query the port mapping relationship of the MS ring protection unit: cfg-get-rmsbdmap
2.4.10 Start the MS ring protocol controller: cfg-start-rms
2.4.11 Stop the MS ring protocol controller: cfg-stop-rms
2.4.12 Initiate the external switchover command of the MS ring: cfg-set-rmsswitch
2.4.13 Query the switchover status of the MS ring protection group: cfg-get-rmsstate
2.4.14 Query the event Logs of the MS ring protection group: cfg-get-rmsevent
2.4.15 Initialize the event logs of the MS switchover process: cfg-init-rmsevent
2.4.16 Set the protocol type of the MS ring protection group: cfg-set-rmsprotocol
2.4.17 Query the protocol type of the MS ring protection group: cfg-get- rmsprotocol
2.4.18 Set the holdoff time for the MS ring switchover: cfg-set-rmsholdofftime
2.4.19 Query the holdoff time for the MS ring switchover: cfg-get-rmsholdofftime
2.4.20 Query the locking status of the MS ring: cfg-get-rmslock
2.4.21 Set the enabling flag of the MS ring service suppression: cfg-set-rmssquflag
2.4.22 Query the enabling flag of the MS ring service suppression: cfg-get-rmssquflag
2.4.23 Set the node configuration table for the whole MS ring: cfg-set-rmsnodemap
2.4.24 Query the node configuration table for the whole MS ring: cfg-get-rmsnodemap
2.4.25 Add the suppression service for the MS ring: cfg-add-rmsringmap
2.4.26 Query the suppression service of the MS ring: cfg-get-rmsringmap
2.4.27 Delete the suppression service of the MS ring: cfg-del-rmsringmap
2.4.28 Clear the suppression service of the MS ring: cfg-clear-rmsringmap
2.4.29 Query the service suppression status of the MS ring: cfg-get-rmssquflag
2.5 SNCP Commands
2.5.1 Add an SNCP group: cfg-add-sncppg
2.5.2 Delete an SNCP group: cfg-del-sncppg
2.5.3 Query all the SNCP groups: cfg-get-sncppg
2.5.4 Set the revert mode and waiting time for recovery for the SNCP group: cfg-set-sncppgpara
2.5.5 Query the revert mode and waiting time for recovery fot the SNCP group: cfg-get-sncppgpara

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 9 of 243
2.5.6 Set the port mapping relationship for the SNCP unit: cfg-set-sncpbdmap
2.5.7 Query the port mapping relationship of the SNCP unit: cfg-get-sncpbdmap
2.5.8 Set the SNCP attributes: cfg-set-sncpattrib
2.5.9 Query the attributes of the SNCP unit: cfg-get-sncpattrib
2.5.10 Initiate the SNCP external switchover command: cfg-set-sncpswitch
2.5.11 Query the switchover status of the SNCP group: cfg-get-sncpstate
2.5.12 Query the SNC node information: cfg-get-sncinfo
2.5.13 Query the diversion of the SNC monitoring point: cfg-get-sncdivert
2.5.14 Enable reporting the SNCP switchover event: cfg-set-sncpreport
2.5.15 Query the enabling status of reporting the SNCP switchover event: cfg-get-sncpreport
2.5.16 Query the SNCP protection group with specified conditions: cfg-get-condsncp
2.5.17 Creat SNCP protection groups on the basis of common services: cfg-convert-xctosncp
2.5.18 Convert the SNCP group to the normal service: cfg-convert-sncptoxc
2.5.19 Add the SNCP protection packet: cfg-add-sncpbindpg
2.5.20 Query information about the protection group in the SNCP protection packet: cfg-get-sncpbindpg
2.5.21 Remove the protection group from the SNCP packet: cfg-remove-sncpbindpg
2.6 TPS Protection
2.6.1 Add a TPS protection group: cfg-add-tpspg
2.6.2 Delete a TPS protection group: cfg-del-tpspg
2.6.3 Query all the TPS protection groups: cfg-get-tpspg
2.6.4 Set the waiting time for recovery for the TPS protection group: cfg-set-tpswtrtime
2.6.5 Query the waiting time for recovery of the TPS protection group: cfg-get-tpswtrtime
2.6.6 Set the mapping relationship between the TPS protection unit and the board: cfg-set-tpsbdmap
2.6.7 Query the mapping relationship between the TPS protection unit and the board: cfg-get-tpsbdmap
2.6.8 Set the switchover priority for the TPS protection unit: cfg-set-tpspri
2.6.9 Query the switchover priority of the TPS protection unit: cfg-get-tpspri
2.6.10 Initiate the TPS external switchover command: cfg-set-tpsswitch
2.6.11 Query the switchover status of the TPS protection group: cfg-get-tpsstate
2.6.12 Query the locking status of the board inside the TPS protection group: cfg-get-tpslockstate
2.6.13 Start the TPS controller: cfg-start-tps
2.6.14 Stop the TPS controller: cfg-stop-tps
2.7 DPS Commands
2.7.1 Query information about the DPS protection group: cfg-get-dpspg
2.7.2 Initiate the DPS external switchover command: cfg-set-dpsswitch
2.7.3 Query the switchover status of the DPS protection group: cfg-get-dpsstate
2.7.4 Set the switchover revert mode for the DPS protection group: cfg-set-dpsrvtmode
2.7.5 Query the switchover revert mode of the DPS protection group: cfg-get-dpsrvtmode
2.7.6 Query the switching times of the DPS protection group: cfg-get-dpsswitchtimes
2.7.7 Clear the switching times record of the DPS protection group: cfg-clear-dpsswitchtimes

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 10 of 243
Keyword:
OSN3500&2500 Command
Summary:
OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference
Abbreviation list:
None.
Reference list:
None.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 11 of 243

Chapter 1 Equipment Management

1.1 Network Element (NE) Properties Management
1.1.1 Initialize all the configuration data of the SCC board: cfg-init-all.

Name cfg-init-all

Function To clear all the configuration data stored on the SCC board.

Command Level System maintenance

Available to User level

Version 5.21.01

Input Format :cfg-init-all

Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-init-all

PrePrecautions Note: Executing this command will clear all the configuration data stored on the SCC board, and the NE will enter
the INSTALLING status. Please be cautious with this command.

Remarks

1.1.2 Initialize all the configuration data of the NE: cfg-init-ne

Name cfg-init-ne

Function To clear the whole NE, including the configuration data stroed on the SCC board and all the service boards.

Command Level System maintenance

Availabe to User level

Version 5.21.01

Input Format :cfg-init-ne

Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-init-ne;

Note: Executing this command will clear all the configuration data stored on the SCC board and all the service
PrePrecautions
boards, and the NE will enter the INSTALLING status. Please be cautious with this command.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 12 of 243

Remarks

1.1.3 Set the device and subrack type: cfg-set-devicetype

Name cfg-set-devicetype

Function To set the device and subrack type for the NE.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-devicetype:NeType,ShelfType
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

NeType: Means the device of the OptiX Osn3500 type;

Input Parameters 1
adopts the value OptiXOsn3500.

2 ShelfTypes: Adopts the fixed value standard.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-devicetype:OptiXOsn3500,standard;

PrePrecautions

Remarks

1.1.4 Query the device and subrack type: cfg-get-devicetype

Name Cfg-get-devicetype

Function To query the device and subrack type of the NE.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-devicetype
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in the table format, with the the relevant fields as:

Output Format NE-TYPE: the device type

SHELF-TYPE: the subrack type

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 13 of 243

:cfg-get-devicetype
DEVICE-TYPE
Example
NE-TYPE SHELF-TYPE
OptiXOsn3500 standard

PrePrecautions

Remarks

1.1.5 Set the NE name: cfg-set-nename

Name cfg-set-nename

Function To set the NE name

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-nename: length,nename
Input Format
Number of parameters: 2; parameters not repetitive.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Length of the NE name: 64 bytes (fixed)

NE name: A character string not more than 64 bytes. If

¡¡ 2
the character string is oversized, cut at the 64th byte.

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-nename:64, ¡°OptiX OSN 3500¡±

PrePrecautions

Remarks

1.1.6 Query the NE name: cfg-get-nename

Name cfg-get-nename

Function To query the NE name.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-nename
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 14 of 243

Return in thetable format, with the relevant fields as:

NE-NAME
Output Format
NENAME_LENGTH NE-NAME
OptiX OSN 3500
Total records :1

Example :cfg-get-nename

PrePrecautions

Remarks

1.1.7 Set the NE position: cfg-set-neposition

Name cfg-set-neposition

Function To set the NE position.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-neposition:neposition
Input Format
Number of parameters 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters NE position description: A character string not more than

1 32 characters. Use the space to fill in the string if it is
less than 32 characters.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-neposition:"ShenZhen HuaWei"

PrePrecautions ¡¡

Remarks

1.1.8 Query the NE position: cfg-get-neposition

Name cfg-get-neposition

Function To query the NE position.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-neposition

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 15 of 243

Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetext format, with the relevant field as:

Output Format
NE-POSITION : the NE position

:cfg-get-neposition
Example
NE-POSITION : ShenZhen HuaWei

PrePrecautions

Remarks

1.1.9 Set the NE memo information: cfg-set-nememo

Name cfg-set-nememo

Function To set the NE memo information.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-nememo:nememo;
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters NE memo information: A character string not more than 32

1 characters. Use space to fill in the string if it is less than 32
characters.

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-nememo:"This is OSN 3500 NE"

Preautions

Remarks

1.1.10 Query the NE memo information: cfg-get-nememo

Name cfg-get-nememo

Function To query the NE memo information.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-nememo

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 16 of 243

Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetext format, with the relevant field as:

Output Format
NE-MEMO: the NE memo information

:cfg-get-nememo
Example
NE-MEMO : This is OSN 3500 NE

Precautions ¡¡

Remarks

1.1.11 Query the NE running status: cfg-get-nestatus

Name cfg-get-nestatus

Function Query the NE running status

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-nestatus
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetext format, with the relevant field as:

Output Format
NE-STATUS: the NE status

:cfg-get-nestatus;
NE-STATUS : install
Example or
:cfg-get-nestatus;
NE-STATUS : running

Precautions

Remarks

1.1.12 Set the NE test switch status: cfg-set-test

Name cfg-set-test

Function To set the status fo the NE test switch.

Command Level System debugging

Available to Internal level

Version 5.21.01

Input Format :cfg-set-test

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 17 of 243

Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 NE test switch status: open or close

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-test:open

Precautions This is an internal command, used for debugging only.

Remarks

1.1.13 Query the NE test switch status: cfg-get-test

Name cfg-get-test

Function To query the status of the NE test switch.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-get-test
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetext format, with the the relevant field as:

Output Format
NE-STATUS: the NE status

:cfg-get-test
Example
TEST_SWITCH : open

Precautions This is an internal command, used for debuggin only.

Remarks

1.1.14 Set the NE service mode: cfg-set-servicemode

Name cfg-set-servicemode

Function To set the NE service mode to the line mode (lucent mode) or the slot mode (HUAWEI mode).

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-servicemode:line or slot
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 18 of 243

Parameter location Parameter meaning and value

Input Parameters Service mode:

1
line: lucent mode
slot: HUAWEI mode

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-servicemode:line

Precautions

Remarks

1.1.15 Query the NE service mode: cfg-get-servicemode

Name cfg-get-servicemode

Function To query the NE service mode: the line mode (lucent mode) or the slot mode (HUAWEI mode).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-servicemode
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format

:cfg-get-servicemode
Example
SERVICE MODE : slot

Precautions

Remarks

1.1.16 Set the switch status of the NE configuration data consistency check: cfg-set-bdcheck

Name cfg-set-bdcheck

Function To set switch status of the NE configuration data consistency check.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-bdcheck:flag
Input Format
Number of parameters 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 19 of 243

Parameter location Parameter meaning and value

Input Parameters
Switch status: enable or disable
1
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bdcheck:enable

Precautions ¡¡

Remarks

1.1.17 Query the switch status of the NE configuration data consistency check switch status:
cfg-get-bdcheck

Name cfg-get-bdcheck

Function To query the switch status of the NE configuration data consistency check.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdcheck
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format

Example :cfg-get-bdcheck

Precautions ¡¡

Remarks

1.1.18 Set the period of the NE configuration data consistency check: cfg-set-bdchecktime

Name cfg-set-bdchecktime

To set the period of the NE configuration data consistency check. The check is performed on the configuration
Function
data of one service board each time.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-bdchecktime;time
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 20 of 243

Parameter location Parameter meaning and value

Input Parameters Consistency check period: 5-30 minutes;

1
Default: 10 minutes.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bdchecktime:20

Precautions

Remarks

1.1.19 Query the period of the NE configuration data consistency: cfg-get-bdchecktime

Name cfg-get-bdchecktime

Function To query the period of the NE configuration data consistency chenck.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdcheck
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format

Example :cfg-get-bdchecktime

Precautions ¡¡

Remarks

1.1.20 Test command of the NE configuration data consistency check: cfg-test-bdcheck

Name cfg-test-bdcheck

Function The test command of the NE configuration data consistency check.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-test-bdcheck:bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 21 of 243

Bid ID of the board for consistency check

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-test-bdcheck:9

Precautions

Remarks

1.1.21 Configuration check: cfg-verify

Name cfg-verify

Function To configure the check command.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-verify
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-verify

Precautions

Remarks

1.1.22 Set the switch status of the low service optimization: cfg-set-lxcoptmz

Name cfg-set-lxcoptmz

Function To set the switch status of the low service optimization.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-set-lxcoptmz:enable or disable
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
Optimization switch status: enable or disable;
1
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 22 of 243

Example :cfg-set-lxcoptmz:enable

Precautions

Remarks The default status is disable.

1.1.23 Query the switch status of the low service optimization: cfg-get-lxcoptmz

Name :cfg-get-lxcoptmz

Function To query the switch status of the low service optimization.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-get-lxcoptmz
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetable format.

Output Format Table heading: LOWXC OPTIMIZE
FLAG

:cfg-get-lxcoptmz
LOWXC OPTIMIZE FLAG
Example
disable
Total records :1

Precautions ¡¡

Remarks

1.2 Basic Board Configuration Commands

1.2.1 Install the board: cfg-add-board

Name cfg-add-board

Function To install the logic board.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-add-board:Bid, BoardType
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 23 of 243

Bid: 1~37 (27 and 28 are PIU¡¯ s; manual installation

1
unnecessary) and 60~67
Input Parameters
2 BoardType: slots supporting these boards

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-add-board:5&6, ssn1sl16

1: The PIU(Power Interface Unit), FAN(Fan Board), AUX(Auxiliary Board) boards and the active SCC board are
automatically installed; manual installation unnecessary.
Precautions
2: The logic board ID is adopted during the board installation; it might be different from the physical slot ID.
3: The active SCC board is installed automatically; the standby SCC board can be installed manually or deleted.

Remarks

1.2.2 Install all boards: cfg-add-allbd

Name cfg-add-allbd

Function One-off installation of all boards.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-add-allbd
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-add-allbd

1: The NE can execute this command only in the INSTALLING status.

2: This command does not process the automatically installed boards.
Precautions
3: This command is used to install the logic board only, and the board is in the ADDING status; after this
command. Use the cfg-verify command to verify manually the configuration, so as to activate the board.

Remarks This command is used for development and testing; for internal use only.

1.2.3 Delete the board: cfg-del-board

Name cfg-del-board

Function To delete a board.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

Input Format :cfg-del-board:Bid

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 24 of 243

Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
Bid: 1~37 (27 and 28 are PIU¡¯ s; cannot be installed or deleted
1
manually), 60~67

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-del-board:1&&3

Precautions

Remarks The auto-installed boards cannot be deleted manually.

1.2.4 Query the installed logic boards in the subrack: cfg-get-board

Name cfg-get-board

Function To query the installed logic boards in the subrack.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-board
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetable format upon success:

:cfg-get-board
INSTALLED-BOARD
Bid BD-TYPE ACTIVE-STATUS
18 nscc active
Output Format 27 piu active
28 piu active
37 aux active
38 fan active
39 fan active
40 fan active

Example :cfg-get-board

Precautions

Remarks

1.2.5 Query the type of the inserted physical board in the subrack: cfg-get-phybd

Name cfg-get-phybd

Function To query the type of the inserted physical board in the subrack.

Command Level System monitoring

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 25 of 243

Available to User level

Version 5.21.01

:cfg-get-phybd
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return in thetable format upon success:

:cfg-get-phybd
PHY-BOARD
Bid BD-TYPE
7 ssn1slq4
8 ssn1sl16
10 gxcsa
11 ssn1sl16
Output Format
12 ssn1slq4
13 ssn1slq4
18 nscc
27 piu
37 aux
38 fan
39 fan
40 fan

Example :cfg-get-phybd

Precautions

Remarks

1.2.6 Reset a board: cfg-reset-board

Name cfg-reset-board

Function To reset a board.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-reset-board:Bid, resetmode
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 26 of 243

1 Bid: 1~18,37, 60~67

Input Parameters Resetmode:

2 hard: hard reset mode
soft: soft reset mode

Output Format

Example :cfg-reset-board:4&6, soft

Precautions

Remarks

1.2.7 Set the alarm threshold for the board temperature: cfg-set-bdtempth

Name cfg-set-bdtempth

Function To set the alarm threshold for the board temperature.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-bdtempth:Bid, temphighgate, templowgate;

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: the board ID

Upper threshold: 600¡«700; unit: 0.1 degree centigrade;

Input Parameters 2 0x7FFF means monitoring unnecessary.
Default: 650

Lower threshold: 0¡«100; unit: 0.1 degree centigrade; 0x7FFF

3 means monitoring unnecessary.
Default: 0

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bdtempth:9,650,50

The upper threshold must be higher than the lower threshold.

Precautions
V100R001 supports setting temperature threshold for only the XCS board.

Remarks

1.2.8 Query the alarm threshold of the board temperature: cfg-get-bdtempth

Name cfg-get-bdtempth

Function To query the alarm threshold of the board temperature.

Command Level System monitoring

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 27 of 243

Available to User level

Version 5.21.01

:cfg-get-bdtempth:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks

Parameter location Parameter meaning and value

Input Parameters
1 Bid: the board ID

Return in thet able format upon success:

:cfg-get-bdtempth:10
Output Format BD-TEMP-TH
TEMP-HIGH TEMP-LOW
650 0

Example :cfg-get-bdtempth:9

Only the setting value is displayed when using this command to query the temperature; unit: 0.1 degree
Precautions centigrade.
V100R001 supports querying the temperature threshold of the XCS board only.

Remarks

1.2.9 Query the board version information: cfg-get-bdversion

Name cfg-get-bdversion

Function To query the board version information.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdversion:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~18,37, 60~67

Return the following in the table format upon success:

¡¡:cfg-get-bdversion:8
Output Format BOARD-VERSION
Bid BD-TYPE RVER DVER HVER ONLINE-FLAG
8 ssn1sl16 0x02 0x0b 0x9044 online

Example :cfg-get-bdversion:4&6

Precautions

Remarks

1.2.10 Query the detail board version information: cfg-get-bdverinfo

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 28 of 243

Name cfg-get-bdverinfo

Function To query the detail board version information.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdverinfo:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~18,37, 60~67

Return the following in the table format upon success:

:cfg-get-bdverinfo:8

Output Format BOARD-VER-INFO

BIOS Version : 2.21
Software Version : 2.11
Logic Version : (U17)200

Example :cfg-get-bdverinfo:4&6

Precautions

Remarks

1.2.11 Set the board parameters: cfg-set-bddata

Name Cfg-set-bddata

Function To resend all the configuration data to the board.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-bddata:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~16(40G XCS)/17(80G XCS),37, 60~67

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bddata:1&6&8

Precautions The SCC and the Ethernet board do not support this command; the board must be connected.

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 29 of 243

1.2.12 Save the board configuration data to the flash: cfg-backup-bdcfg

Name cfg-backup-bdcfg

Function To save the board configuration data to the flash.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-backup-bdcfg:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~16(40G)/17(80G),37

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-backup-bdcfg:4

Precautions

Remarks

1.2.13 Clear the board configuration data in the flash: cfg-clear-bdcfg

Name cfg-clear-bdcfg

Function To clear the configuration data of the designated board in the flash.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-clear-bdcfg:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~16(40G)/17(80G),37

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-clear-bdcfg:4

Precautions

Remarks

1.2.14 Query the board configuration data backup: cfg-get-bdcfg

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 30 of 243

Name cfg-get-bdcfg

Function To query the board configuration data backup.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdcfg:Bid
Input Format
Number of parameters: 1; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~16(40G)/17(80G),37

¡¡:cfg-get-bdcfg:8
BDCFG-STATUS
Output Format
Bid BDCFG-FLAG TIME-INFO
8 yes 2004-11-5 17:27:9

Example :cfg-get-bdcfg:4

Precautions

Remarks

1.2.15 Set automatic clear: cfg-set-autoclear

Name cfg-set-autoclear

Function To set the automatic clear of an operation.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-autoclear: AutoClearType, AutoClearStatus, AutoClearTime

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 AutoClearType: portloop or au4loop

Input Parameters

2 AutoClearStatus: disable or enable (default)

AutoClearTime: 1~2880 minutes, 5 minutes by default£»

3 Fill 0 minutes for AutoClearTime when AutoClearStatus is
disable.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 31 of 243

Example :cfg-set-autoclear:portloop,enable,5

Precautions

Remarks

1.2.16 Query the automatic clear: cfg-get-autoclear

Name cfg-get-autoclear

Function To query the automatic clear of a specified operation.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-autoclear:AutoClearType
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 AutoClearType: portloop or au4loop

Return the following in the table format upon success:

:cfg-get-autoclear:portloop
Output Format
AUTOCLEAR
TYPE AUTOCLEAR AUTOCLEARTIME
portloop enable 5

Example :cfg-get-autoclear:portloop

Precautions

Remarks

1.2.17 Query the loop auto clear information of the Ethernet board: cfg-get-ethlooplist

Name cfg-get-ethlooplist

To query the loop auto clear information of the Ethernet board, and to return the current Ethernet board
Function
information in the loop auto clear link list.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-ethlooplist:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 32 of 243

Parameter location Parameter meaning and value

Input Parameters
Bid (Ethernet board ID): 1~8,11~16(40G)/17(80G); support the
1
parameter 0 (querying all the boards).

Return the following in the table format upon success:

:cfg-get-ethlooplist:0;
ETH-LOOP-LIST
BID ACL_TYPE LOOP_TYPE PORT PATH OVERTIME
5 vc3loop vc3path 1 1 4
Output Format 5 vc3loop vc3path 1 2 4
5 vc3loop vc3path 1 3 4
5 vc3loop vc3path 1 4 4
5 vc3loop vc3path 1 5 4
5 vc3loop vc3path 1 6 4
5 vc3loop vc3path 1 7 4
5 vc3loop vc3path 1 8 4

Example :cfg-get-ethlooplist:0

Precautions

Remarks

1.2.18 Query the board working status: cfg-get-workstat

Name cfg-get-workstat

Function To query the working status of a board.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-workstat:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1~18, 37

Return the following in the table format upon success:

:cfg-get-workstat:8
Output Format
BD-WORK-STATUS
BID WORK-STAT
8 working

Example :cfg-get-workstat:8

Precautions

Remarks

1.2.19 Set the FAN running mode: cfg-set-fanmode

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 33 of 243

Name cfg-set-fanmode

Function To set the FAN running mode.

Command Level System operation

Available to Customer service level

Version 5.21.01

:cfg-set-fanmode:FanMode
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters FanMode:

auto: The FAN adjusts the speed automatically according to
1
the entironment temperature.
manu: The FAN runs in the manually-set speed.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-fanmode:manu

Precautions

Remarks

1.2.20 Query the FAN running mode: cfg-get-fanmode

Name cfg-get-fanmode

Function To query the FAN running mode.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-fanmode
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return the following in the text format upon success:

Output Format
:cfg-get-fanmode
FAN-MODE : auto

Example :cfg-get-fanmode

Precautions

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 34 of 243

1.2.21 Set the FAN speed: cfg-set-fanspeed

Name cfg-set-fanspeed

Function To set the FAN speed.

Command Level System operation

Available to Customer service level

Version 5.21.01

:cfg-set-fanspeed:FanSpeed
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

FanSpeed: the FAN speed:

Input Parameters high: full speed
1 mid: middle speed
low: low speed
stop: stop

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-fanspeed:mid

Precautions This command is effective only when the FAN mode is manu.

Remarks

1.2.22 Query the manually-set FAN speed: cfg-get-fanspeed

Name cfg-get-fanspeed

Function To query the manually-set FAN speed; not the current FAN speed.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-fanspeed
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return the following in the text format upon success:

Output Format
:cfg-get-fanspeed
FAN-SPEED : high

Example :cfg-get-fanspeed

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 35 of 243

This command can only query the manually-set instead of the current FAN speed. Use the cfg-get-fanspeed
Precautions
command to query the current FAN speed.

Remarks

1.2.23 Query the current FAN information: cfg-get-fancurinfo

Name cfg-get-fancurinfo

Function To query the current FAN information.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-fancurinfo
Input Format
Number of parameters: 0; parameters not repetitive.

Input Parameters No parameter.

Return the following in the text format upon success:

:cfg-get-fancurinfo
FAN-CUR-INFO
Output Format Online AlmStat CurSpeed
online 0 high
online 0 high
online 0 high
Total records :3

Example :cfg-get-fancurinfo

Precautions The current FAN information includes the FAN status, alarm status and the current speed.

Remarks

1.3 Common Configuration Commands for Service Boards

1.3.1 Set the AIS inserting status of the alarm event: cfg-set-alm2ais

Name cfg-set-alm2ais

Function To set whether the alarm event inserts AIS.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-alm2ais:Bid, Pid, AlmEid, Flag

Input Format

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 36 of 243

Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
AlmEid: roof,hptim,hpslm,hpuneq,hplom,b1exc,b1sd,b2exc,b2sd,b3exc,b3sd,
3
lptim,lpuneq,lpslm,bipexc;

Flag: disable or enable

4
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-alm2ais:6&8,1, msais&msrdi,enable

Precautions This command applies to the line board, tributary board and the Ethernet board.

Remarks

1.3.2 Query the AIS inserting status of the alarm event: cfg-get-alm2ais

Name cfg-get-alm2ais

Function To query whether the alarm event inserts the AIS.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-alm2ais:Bid, Pid, AlmEid

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

AlmEid: roof,hptim,hpslm,hpuneq,hplom,b1exc,b1sd,b2exc,b2sd,b3exc,b3sd,
3
lptim,lpuneq,lpslm,bipexc;

Return the following in the text format upon success:

:cfg-get-alm2ais:8,1,auais&aulop
Output Format
ALM2AIS-STATUS
Bid Pid ALARM-EID AIS-ENABLE
8 1 auais enable

Example :cfg-get-alm2ais:8,1,auais&msrdi

Precautions This command applies to the line board, tributary board and Ethernet board.

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 37 of 243

1.3.3 Set the transmission switch of the overhead byte: cfg-set-tohenable

Name cfg-set-tohenable

Function To enable/disable setting the transmission switch of the overhead bytel.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tohenable:Bid, Flag
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)
¡¡
¡¡
Flag: disable or enable
2
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tohenable:1&2,disable

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

This command applies currently only to the tributary board; the line board does not support the transmission
Remarks
configuration of the overhead byte.

1.3.4 Query the transmission switch of the overhead byte: cfg-get-tohenable

Name cfg-get-tohenable

Function To query the transmission switch status of the overhead byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tohenable:Bid
Input Format
Number of parameters: 1; repetitive prameter blocks.

Parameter location Parameter meaning and value

Input Parameters
¡¡
1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Return the following in the text format upon success:

:cfg-get-tohenable:2
Output Format TOH-ENABLE-STATUS
Bid TOH-ENABLE
2 disable
Total records :1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 38 of 243

Example :cfg-get-tohenable:6

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

This command applies currently only to the tributary board; the line board does not support the transmission
Remarks
configuration of the overhead byte.

1.3.5 Set the port loop mode: cfg-set-loop

Name cfg-set-loop

Function To set the port loop mode of the optical, electrical and tributary port.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-loop:Bid, Pid, loopmode

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

loopmode: loopin,loopout or noloop

3
Default: noloop

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-loop:6&8,1,loopin

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks

1.3.6 Query the port loop mode: cfg-get-loop

Name cfg-get-loop

Function To query the port loop mode.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-loop:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 39 of 243

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

Return in the table format upon success, with the relevant fields as:
Output Format
Bid, Pid and LOOP-MODE

:cfg-get-loop:4,1
LOOP-STATUS
Example Bid Pid LOOP-MODE
4 1 noloop
Total records :1

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks

1.4 Commands for Configuring Line Board Properties

1.4.1 Set vc4 path loopback: cfg-set-vc4loop

Name cfg-set-vc4loop

Function To set vc4 path loopback.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-vc4loop:Bid, Pid, AU4Id ,loopmode

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS); 1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
3 AU4Id: 1-X (Determine X according to the board type.)

loopmode: loopin or loopout or noloop

4
Default: noloop

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vc4loop:6&8,1,1,loopin

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks The N2-series boards do not support VC4 loopback because of the chip defect.

1.4.2 Query the vc4 path loop mode: cfg-get-vc4loop

Name cfg-get- vc4loop

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 40 of 243

Function To query the vc4 path loop mode.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get- vc4loop:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-vc4loop:11,1,1
Output Format PATHLOOP-STATUS
Bid Pid AU4Id LOOP-MODE
11 1 1 noloop
Total records :1

Example :cfg-get- vc4loop:4,1,1

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks The N2-series boards do not support VC4 loopback because of the chip defect.

1.4.3 Set the laser switch status: cfg-set-laser

Name cfg-set-laser

Function To set the status of the laser switch (The system defaults it as open).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-laser:Bid, Pid, status

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X is according to the board type.)

Status:open or close
3
Default: open

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 41 of 243

Example :cfg-set-laser:6&&8,1,close

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks

1.4.4 Query the laser switch status: cfg-get-laser

Name cfg-get-laser

Function To query the status of the laser switch.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-laser:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-laser:11,1;
LASER-SWITCH-STATUS
Output Format
Bid Pid LASER-STATUS
11 1 open
Total records :1

Example :cfg-get-laser:6&&8,1

This command is effective to the optical board only. This command is delivered directly to the board, therefore
Precautions
the board must be connected.

Remarks ¡¡

1.4.5 Set the ALS: cfg-set-als

Name cfg-set-als

To set ALS.
Function A technique (procedure) to automatically shutdown the output power of laser transmitters and optical amplifiers
to avoid exposure to hazardous levels.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-als:Bid, Pid, Flag

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 42 of 243

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

Flag:disable or enable
3
Default: enable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-als:6&&8,1,enable

Precautions This command applies to the optical service processing board and the optical amplifier board.

Remarks ALS(automatic laser shutdown, ITU-T G.664)

1.4.6 Query the ALS status: cfg-get-als

Name cfg-get-als

Function To query the ALS status.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-als:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-als:6,1;
Output Format ALS-STATUS
Bid Pid ALS-ENABLE
6 1 disable
Total records :1

Example :cfg-get-als:6&&8,1&&2;

Precautions This command applies to the optical board only.

Remarks ¡¡

1.4.7 Set the ALS time parameter: cfg-set-alstime

Name cfg-set-alstime

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 43 of 243

Function To set the ALS time parameter.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-alstime:Bid, Pid, opentime, closetime, testtime

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
3 opentime: 0-65535; unit: 10ms; default: 200 (2s)

4 closetime: 0-65535; unit: 10ms; default: 6000 (60s)

5 testtime: 0-65535; unit: 10ms; default: 9000 (90s)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-alstime:6,1&2,200,6000,9000

Precautions This command applies to the optical board only.

Remarks

1.4.8 Query the ALS time parameter: cfg-get-alstime

Name cfg-get-alstime

Function To query the ALS time parameter.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-alstime:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Example
:cfg-get-alstime:6,1;
ALS-TIME(10ms)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 44 of 243

Bid Pid OPEN-TIME CLOSE-TIME TEST-TIME

6 1 200 6000 9000
Total records :1

Precautions This command applies to the optical board only.

Remarks The set value (unit: 10ms) is obtained through query using the command line.

1.4.9 Laser ALS constantly in the testing status: cfg-test-als

Name cfg-test-als

Function The laser ALS is constantly in the testing tatus.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-test-als:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-test-als:6,1&2

This command applies to the optical board only.

Precautions This command is delivered directly to the board. Therefore, the board must be connected.
Set the time for the constant testing status of the laser LAS in the time parameter setting; defaulted as 90s.

Remarks

1.4.10 Set the thresholding-crossing and the degraded threshold of B1B2B3: cfg-set-b1b2b3th

Name cfg-set-b1b2b3th

Function To set the threshold-crossing and the degraded threshold of the B1B2B3 error.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-b1b2b3th:Bid, Pid, th-type, exec_th, sd_th

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 45 of 243

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

th-type:
b1th (B1 threshold) or
3 b2th (B2 threshold) or
b3th (B3 threshold) or
b3iec(B3-IEC threshold)

exec_th:
1 (1.0E-9) or
2 (1.0E-8) or
3 (1.0E-7) or
Input Parameters 4 4 (1.0E-6) or
5 (1.0E-5) or
6 (1.0E-4) or
7 (1.0E-3)
Default: 7

Sd_th:
1 (1.0E-9) or
2 (1.0E-8) or
3 (1.0E-7) or
5 4 (1.0E-6) or
5 (1.0E-5) or
6 (1.0E-4) or
7 (1.0E-3)
Default: 4

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-b1b2b3th:6&&8,1&2,b1th,7,4

Precautions The threshold-crossing must be higher than the degraded threshold.

According to the ITU-TG.783 recommendation, the detection start and end time vary according to the threshold
of the inserted error. Generally, every lower level has a ten times increase in the time.
Take the default situation for example: Insert the b1 error at the rate of 1E-4, and the b1sd alarm terminates the
Remarks
time the insertion is completed. If setting the threshold of b1over to 1E-5 and that of b1sd to 1E-7, insert the b1
error at the rate of 1E-4, and the b1over alarm terminates the time the insertion is completed. However, the b1sd
alarm will be generated successively, which will last around 10s.

1.4.11 Query the threshold-crossing and the degraded threshold of B1B2B3: cfg-get-b1b2b3th

Name cfg-get-b1b2b3th

Function To query the threshold-crossing and the degraded threshold of the B1B2B3 error.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-b1b2b3th:Bid, Pid, th-type

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 46 of 243

2 Pid: 1-X (Determine X according to the board type.)

th-type:
Input Parameters b1th (B1 threshold) or
3 b2th (B2 threshold) or
b3th (B3 threshold) or
b3iec(B3-IEC threshold)

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-b1b2b3th:6,1,b1th;
Output Format B1B2B3-TH
Bid Pid TH-TYPE EXEC-TH SD-TH
6 1 b1th 7 4
Total records :1

Example :cfg-get-b1b2b3th:6&&8,1&2,b1th

Precautions ¡¡

Remarks ¡¡

1.4.12 Set the to-be-sent J0 bytes: cfg-set-stj0

Name cfg-set-stj0

Function To set the to-be-sent J0 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stj0:Bid, Pid, J0mode, J0value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

J0mode:

Value Meaning
Input Parameters 0 SDH mode (The bit7 of the first and only the first byte of
the J0 byte sequence is 1.)
3
1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode

Default: 1

J0 (Value: a character string not more than 16 bytes).

4
Default: ¡° HuaWei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stj0:6&&8,1&2,1," HuaWei SBS "

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 47 of 243

This command applies to LU boards only.

Precautions
Defaut:¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end)

Remarks

1.4.13 Query the to-be-sent J0 bytes: cfg-get-stj0

Name cfg-get-stj0

Function To query the to-be-sent J0 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stj0:Bid, Pid
Input Format
Number of parameters 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-stj0:6,1;
Output Format STJ0
Bid Pid J0MODE J0VALUE
6 1 1 HuaWei SBS
Total records :1

Example :cfg-get-stj0:6&&8,1&2

Precautions This command applies to LU boards only.

Remarks ¡¡

1.4.14 Set the receivable J0 bytes: cfg-set-srj0

Name cfg-set-srj0

Function To set the receivable J0 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-srj0:Bid, Pid, J0mode, J0value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 48 of 243

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

J0mode:
Value Meaning:
0 SDH mode (The bit7 of the first and only the first byte of
Input Parameters the J0 byte sequence is 1.)
3
1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode
Default value: 1

J0value: a character string not more than 16 bytes

4
Default: ¡° HuaWei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srj0:6&&8,1&2,1," HuaWei SBS "

This command applies to LU boards only.

Precautions
Default value:¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end).

Remarks ¡¡

1.4.15 Query the receivable J0 bytes: cfg-get-srj0

Name cfg-get-srj0

Function To query the receivable J0 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj0:Bid, Pid
Input Format
Number of parameters: 2; receivable parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srj0:6&&8,1&2

Precautions This command applies to LU boards only.

Remarks ¡¡

1.4.16 Query the received J0 bytes: cfg-get-rj0

Name cfg-get-rj0

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 49 of 243

Function To query the received J0 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rj0:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rj0:6&&8,1&2

Precautions This command applies to the in-position LU boards only.

Remarks ¡¡

1.4.17 Set the to-be-sent J1 bytes: cfg-set-stj1

Name cfg-set-stj1

Function To set the to-be-sent J1 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stj1:Bid, Pid, AU4Id, J1mode, J1value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

J1mode:
Input Parameters
0 SDH mode (The bit7 of the first and only the first byte of
the J1 byte sequence is 1.)
4 1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default value: 1

J1value:
If the j1 protocol mode adoapts 0 and 1, J1 is a character string

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 50 of 243

not more than 16 bytes.

If the j1 protocol mode adopts 2, J1 is a character string not
5
more than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format ¡¡Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stj1:6&&8,1,1&&16,1," HuaWei SBS "

When the j1 protocol mode adopts 0 and 1, the j1 character string can be more than 16 bytes. However, only the
first 16 bytes are valid.
Precautions Default: ¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end)
The to-be sent J1 string can be set for the VC12 service. In terms of the VC3 service, the lower oder sevice can
be set while the higher order service cannot.

Remarks

1.4.18 Query the to-be-sent J1 bytes: cfg-get-stj1

Name cfg-get-stj1

Function To query the to-be-sent J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stj1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srj1:6&&8,1,1&&16

Precautions

Remarks

1.4.19 Set the receivable J1 byets:cfg-set-srj1

Name cfg-set-srj1

Function To set the receivable J1 byets.

Command Level System maintenance

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 51 of 243

Version 5.21.01

:cfg-set-srj1:Bid, Pid, AU4Id, J1mode, J1value

Input Format
Number parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

J1mode:
0 SDH mode (The bit7 of the first and only the first byte of
Input Parameters the J1 byte sequence is 1.)
4 1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default: 1

J1value:
If the j1 protocol mode adopts 0 and 1, J1 is a character string
not more than 16 bytes.
5
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srj1:6&&8,1,1&&16,1," HuaWei SBS "

Precautions

Remarks

1.4.20 Query the receivable J0 bytes: cfg-get-srj1

Name cfg-get-srj1

Function To query the receivable J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 52 of 243

Output Format ¡¡Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srj1:6&&8,1,1&&16

Precautions ¡¡

Remarks ¡¡

1.4.21 Query the received J1 bytes: cfg-get-rj1

Name cfg-get-rj1

Function To query the received J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rj1:6&&8,1,1&&16

Precautions This command appies to the in-position line board only.

Remarks

1.4.22 Set the to-be-sent J1 bytes (support AU3): cfg-set-stj1ex

Name cfg-set-stj1ex

Function To set the to-be-sent J1 bytes (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stj1ex:Bid, Pid, AU4Id, AU3Id, J1mode, J1value

Input Format
Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 53 of 243

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

J1mode:
0 SDH mode (The bit7 of the first and only the first byte of
Input Parameters the J1 byte sequence is 1.)
5 1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default: 1

J1value:
If the j1 protocol mode adopts 0 and 1, J1 is a character string
not more than 16 bytes.
6
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stj1ex:6&&8,1,1&&16,1,1," HuaWei SBS "

Precautions

Remarks

1.4.23 Query the to-be-sent J1 bytes (support AU3): cfg-get-stj1ex

Name cfg-get-stj1ex

Function To query the to-be-sent J1 bytes (supportAU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stj1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-stj1ex:6&&8,1,1&&16,1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 54 of 243

Precautions ¡¡

Remarks ¡¡

1.4.24 Set the receivable J1 bytes (support AU3): cfg-set-srj1ex

Name cfg-set-srj1ex

Function To set the to-be-received J1 bytes (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-srj1ex:Bid, Pid, AU4Id, AU3Id, J1mode, J1value

Input Format
Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

J1mode:
Value Meaning
Input Parameters
0 SDH mode (The bit7 of the first and only the first byte of
the J1 byte sequence is 1.)
5
1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default: 1

J1value:
If the j1 protocol mode adopts 0 and 1, J1 is a character string
not more than 16 bytes.
6
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srj1ex:6&&8,1,1&&16,1,1," HuaWei SBS "

Precautions

Remarks

1.4.25 Query the receivable J1 bytes (suppot AU3): cfg-get-srj1ex

Name cfg-get-srj1ex

Function To query the receivable J1 bytes (support AU3).

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 55 of 243

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srj1ex:6&&8,1,1&&16,1

Precautions ¡¡

Remarks ¡¡

1.4.26 Query the received J1 bytes (support AU3): cfg-get-rj1ex

Name cfg-get-rj1ex

Function To query the received J1 bytes (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rj1ex:6&&8,1,1&&16,1

Precautions This command applies to the in-position line board.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 56 of 243

Remarks

1.4.27 Set the monitoring status of the pass-through J1/C2 byte: cfg-set-j1c2monitor

Name cfg-set-j1c2monitor

Function To set the monitoring status of the pass-through J1/C2 byte.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-j1c2monitor:Bid, Pid, Flag

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

Flag:
disable (not monitor)
3
enable (monitor)
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-j1c2monitor:1&2,1&&4,enable

Precautions

Remarks

1.4.28 Query the monitoring status of the pass-through J1/C2 byte: cfg-get-j1c2monitor

Name cfg-get-j1c2monitor

Function To query the monitoring status of the pass-through J1/C2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-j1c2monitor:Bid, Pid
Input Format
Number of parameters 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 57 of 243

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-j1c2monitor:1&2,1&&4

Precautions

Remarks

1.4.29 Set the to-be-sent C2 byte: cfg-set-stc2

Name cfg-set-stc2

Function To set the to-be-sent C2 byte.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stc2:Bid, Pid, AU4Id, C2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

C2value:
Value Meaning
uneq singal uneuipped
unsp non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s singnals,
asynchronously mapped into C-3
develop Mapping to be developed
Input Parameters a140 139.264Mbit/s signal, asynchronously mapped into
C--4
atm ATM mapping
man MAN (DQDB) mapping
fddi FDDI
4
ppp PPP
synsdl Simple data link mapping of the SDH self-
synchronizing scrambler
laps LAPS
setsdl Set and reset the simple data link mapping of the
scrambler
enet 10G Ethernet network signal mapping
gfp Changeable topological data connection mapping
resv Reserved
resvn1 Reseerved for the national use
resvn2 Reseerved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 58 of 243

Example :cfg-set-stc2:6&&8,1,1&&16,tugs

Precautions

Remarks

1.4.30 Query the to-be-sent c2 byte: cfg-get-stc2

Name cfg-get-stc2

Function To query the to-be-sent c2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stc2:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-stc2:6&&8,1,1&&16

Precautions

Remarks

1.4.31 Set the receivable C2 byte: cfg-set-src2

Name cfg-set-src2

Function To set the receivable C2 byte.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-src2:Bid, Pid, AU4Id, C2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 59 of 243

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

C2value:
Value Meaning
uneq Signal unequipped
unsp Non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s signals, asynchronously
mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into C-4
Input Parameters atm ATM mapping
man MAN (DQDB) mapping
4 fddi FDDI
ppp HDLC/PPP signal mapping
resvn3 Reserved
laps HDLC/LAPS signal mapping
resvn4 Reserved
enet 10G Ethernet network signal mapping
gfp GFP mapping
resv Reserved
resv1 Reserved for the national use
resv2 Reserved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-src2:6&&8,1,1&&16,tugs

Precautions ¡¡

Remarks ¡¡

1.4.32 Query the receivable C2 byte: cfg-get-src2

Name cfg-get-src2

Function To query the receivable C2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-src2:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 60 of 243

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-src2:6&&8,1,1&&16

Precautions ¡¡

Remarks ¡¡

1.4.33 Query the received C2 byte: cfg-get-rc2

Name cfg-get-rc2

Function To query the received C2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rc2:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rc2:6&&8,1,1&&16

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks ¡¡

1.4.34 Set the to-be-sent C2 byte (support AU3): cfg-set-stc2ex

Name cfg-set-stc2ex

Function To set the to-be-sent C2 byte (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stc2ex:Bid, Pid, AU4Id, AU3Id, C2value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 61 of 243

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

C2value:
Value Meaning
uneq Sinal unequipped
unsp Non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s signals, asynchronously
mapped into C-3
Input Parameters
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into C--4
atm ATM mapping
man MAN (DQDB) mapping
5 fddi FDDI
ppp HDLC/PPP signal mapping
resvn3 Reserved
laps HDLC/LAPS signal mapping
resvn4 Reserved
enet 10G Ethernet network signal mapping
gfp GFP mapping
resv Reserved
resv1 Reserved for the national use
resv2 Reserved for the national use
test 0.181 test signal
ais VC-AIS (used for the serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stc2ex:6&&8,1,1&&16,1,tugs

Precautions ¡¡

Remarks ¡¡

1.4.35 Query the to-be-sent C2 byte (support AU3): cfg-get-stc2ex

Name cfg-get-stc2ex

Function To query the to-be-sent C2 byte (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stc2ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 62 of 243

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters 3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-stc2ex:6&&8,1,1&&16,1

Precautions ¡¡

Remarks ¡¡

1.4.36 Set the receivable C2 byte (support AU3): cfg-set-src2ex

Name cfg-set-src2ex

Function To set the receivable C2 byte (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-src2ex:Bid, Pid, AU4Id, AU3Id, C2value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

C2value:
Value Meaning
uneq Sinal unequipped
unsp Non-specific payload equipped
tugs TUG structure
Input Parameters tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s signals, asynchronously
mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into C--4
atm ATM mapping
5
man MAN (DQDB) mapping
fddi FDDI
ppp HDLC/PPP signal mapping
resvn3 Reserved
laps HDLC/LAPS signal mapping
resvn4 Reserved
enet 10G Ethernet network signal mapping
gfp GFP mapping
resv Reserved
resv1 Reserved for the national use
resv2 Reserved for the national use

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 63 of 243

test 0.181 test signal

ais VC-AIS (used for the serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-src2ex:6&&8,1,1&&16,1,tugs

Precautions ¡¡

Remarks ¡¡

1.4.37 Query the receivable C2 byte (support AU3): cfg-get-src2ex

Name cfg-get-src2ex

Function To query the receivable C2 byte (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-src2ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format ¡¡

Example :cfg-get-src2ex:6&&8,1,1&&16,1

Precautions Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Remarks ¡¡

1.4.38 Query the received C2 byte (support AU3): cfg-get-rc2ex

Name cfg-get-rc2ex

Function To query the received C2 byte (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 64 of 243

:cfg-get-rc2ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rc2ex:6&&8,1,1&&16,1

Precautions This command is delivered directly to the board. Therefore, the board must be connected.

Remarks ¡¡

1.4.39 Set the status of B2EXC and MSAIS (as the clock source switchover condition): cfg-set-
alm2clksw

Name cfg-set-alm2clksw

Function To set the status of B2EXC and MSAIS (as the clock source switchover condition).

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-alm2clksw:Bid, Pid, AlmEid, Flag

Input Format
Nubmer of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters AlmEid:

3 msais (Multi-Section Alarm Insert Signal)
b2exc

Flag:
disable
4
enable
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example cfg-set-alm2clksw :1&2,1&&4,b2exc&msais,enable

Precautions

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 65 of 243

Remarks

1.4.40 Query the status of B2EXC and MSAIS (as the clock source switchover condition): cfg-get-
alm2clksw

Name cfg-get-alm2clksw

Function To query the status of B2EXC and MSAIS (as the clock source switchover condition).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-alm2clksw :Bid, Pid, AlmEid

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

AlmEid:
3 msais (Multi-Section Alarm Insert Signal)
b2exc

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-alm2clksw :1&2,1&&4,b2exc&msais

Precautions

Remarks

1.4.41 Set the to-be-sent N1 bytes: cfg-set-stn1

Name cfg-set-stn1

Function To set the to-be-sent N1 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-stn1:Bid, Pid, AU4Id, N1mode, N1value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 66 of 243

3 AU4Id: 1-X (Determine X according to the board type.)

N1mode:

Value Meaning
0 CRC verification mode (The bit7 of the first byte in theN1
Input Parameters
4 byte sequence is 1, and the bit7 of other bytes is 0.)
1 CRC verification mode (Adopt forcibly CRC verification to
generate the first byte.)

Default: 1

N1value: a character string not more than 16 bytes.

5
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stn1:1&2,1,1&&16,1," HuaWei SBS "

Precautions

Remarks

1.4.42 Query the to-be-sent N1 bytes: cfg-get-stn1

Name cfg-get-stn1

Function To query the to-be-sent N1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stn1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-stn1:1&2,1,1&&16

Precautions

Remarks

1.4.43 Set the receivable N1 bytes: cfg-set-srn1

Name cfg-set-srn1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 67 of 243

Function To set the receivable N1 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-srn1:Bid, Pid, AU4Id, N1mode, N1value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Input Parameters N1mode:

Value Meaning
0 CRC verification mode (The bit7 of the first byte in theN1
4 byte sequence is 1, and the bit7 of other bytes is 0.)
1 CRC verification mode (Adopt forcibly CRC verification to
generate the first byte.)

Default: 1

N1value: a character string not more than 16 bytes.

5
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srn1:1&2,1,1&&16,1," HuaWei SBS "

Precautions

Remarks

1.4.44 Query the receivable N1 bytes: cfg-get-srn1

Name cfg-get-srn1

Function To query the receivable N1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srn1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 68 of 243

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srn1:1&2,1,1&&16

Precautions

Remarks

1.4.45 Query the received N1 bytes: cfg-get-rn1

Name cfg-get-rn1

Function To query the received N1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rn1:Bid, Pid, AU4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rn1:1&2,1,1&&16

Precautions

Remarks

1.4.46 Set the to-be-sent N1 bytes (support AU3): cfg-set-stn1ex

Name cfg-set-stn1ex

Function To set the to-be-sent N1 bytes (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

Input Format :cfg-set-stnex:Bid, Pid, AU4Id, AU3Id, N1mode, N1value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 69 of 243

Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

3 AU3Id: 0-3
Input Parameters
N1mode:

Value Meaning
0 CRC verification mode (The bit7 of the first byte in theN1
5 byte sequence is 1, and the bit7 of other bytes is 0.)
1 CRC verification mode (Adopt forcibly CRC verification to
generate the first byte.)

Default: 1

N1value: a character string not more than 16 bytes.

6
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stn1ex:1&2,1,1&&16,1,1," HuaWei SBS "

Precautions

Remarks

1.4.47 Query the to-be-sent N1 bytes (support AU3): cfg-get-stn1ex

Name cfg-get-stn1ex

Function To query the to-be-sent N1 bytes (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stn1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 70 of 243

Example :cfg-get-stn1ex:1&2,1,1&&16,1,1

Precautions

Remarks

1.4.48 Set the receivable N1 bytes (support AU3): cfg-set-srn1ex

Name cfg-set-srn1ex

Function To set the receivable N1 bytes (support AU3).

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-srn1ex:Bid, Pid, AU4Id, AU3Id, N1mode, N1value

Input Format
Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3
Input Parameters
N1mode:

Value Meaning
0 CRC verification mode (The bit7 of the first byte in theN1
5 byte sequence is 1, and the bit7 of other bytes is 0.)
1 CRC verification mode (Adopt forcibly CRC verification to
generate the first byte.)

Default: 1

N1value: a character string not more than 16 bytes.

6
Default: ¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srn1ex:1&2,1,1&&16,1,1," HuaWei SBS "

Precautions

Remarks

1.4.49 Query the receivable N1 bytes (support AU3): cfg-get-srn1ex

Name cfg-get-srn1ex

Function To query the receivable N1 bytes (support AU3).

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 71 of 243

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srn1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 0-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srn1ex:1&2,1,1&&16,1

Precautions

Remarks

1.4.50 Query the received N1 bytes (support AU3): cfg-get-rn1ex

Name cfg-get-rn1ex

Function To query the received N1 bytes (support AU3).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rn1ex:Bid, Pid, AU4Id, AU3Id

Input Format
Number of parameters 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 AU4Id: 1-X (Determine X according to the board type.)

4 AU3Id: 1-3

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rn1ex:1&2,1,1&&16,1

Precautions

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 72 of 243

Remarks

1.4.51 Set the overhead extraction function: cfg-set-rohdrop

Name cfg-set-rohdrop

Function To set the overhead extraction function.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-rohdrop: Bid, Pid, RohdropNum, Rohdroppos, muldepth

Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

RohdroppNum: 0~4 (0 stands for no extraction; the followed

Input Parameters 3
parameters are invalid.)

Rohdroppos: Location of the Y(1-4) overhead. The high 4bit

stands for the row number of the overhead in the SDH frame
2*(Y+1)
(1~9), and the low 4bit for the line number of the extraction in
the SDH frame (1~9).

muldepth: Multiplex depth of the Y overhead (Value range: 1-N;

2*(Y+1)+1
N stands for the optical interface rate STM-N; the max N is 64.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example cfg-set-rohdrop

Precautions

Remarks

1.4.52 Query the overhead extraction function: cfg-get-rohdrop

Name cfg-get-rohdrop

Function Query the overhead extraction function.

Command Level System monitoring

Available to User level

Version 5.21.01

cfg-get-rohdrop:Bid,Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 73 of 243

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-rohdrop:6,1

Precautions

Remarks

1.4.53 Set the status of TCM: cfg-set-tcm

Name cfg-set-tcm

Function To set the status of TCM.

Command Level System operation

Available to User level

Version 5.21.01

cfg-set-tcm:Bid,Pid,Au4Id,N1Pos,Flag
Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
3 Au4Id: 1-X (Determine X according to the board type.)

4 N1Pos: source£¬dest(destination)

Flag: disable, enable

5
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tcm:1&2,1&&4,1&2,source,enable

Precautions Only the N2-series boards support TCM.

Remarks TCM (abbr. Tandem Connection Monitoring)

1.4.54 Query the status of TCM: cfg-get-tcm

Name cfg-get-tcm

Function To query the status of TCM.

Command Level System monitor

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 74 of 243

Available to User level

Version 5.21.01

cfg-get-tcm:Bid,Pid,Au4Id
Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 Au4Id: 1-X (Determine X according to the board type.)

:cfg-get-tcm:8,1,1
¡¡ TCACTIVITY
Output Format
Bid Pid AU4ID SrcEnable DstEnable
8 1 1 enable disable

Example :cfg-get-tcm:8,1,0

Precautions Only the N2-series boards support TCM.

Remarks TCM (abbr. Tandem Connection Monitoring)

1.4.55 Set the status of TCM (support AU3): cfg-set-tcmex

Name cfg-set-tcmex

Function To set the status of TCM (support AU3).

Command Level System monitor

Available to User level

Version 5.21.01

cfg-set-tcmex:Bid,Pid,Au4Id,Au3Id,N1Pos,Flag
Input Format
Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

3 Au4Id: 1-X (Determine X according to the board type.)

Input Parameters
4 Au3Id: 1-3

5 N1Pos: source£¬dest (destination)

Flag: disable, enable

6
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 75 of 243

Example :cfg-set-tcmex:1&2,1&&4,1&2,1,source,enable

Precautions Only the N2-series boards support TCM.

Remarks TCM (abbr. Tandem Connection Monitoring)

1.4.56 Query the status of TCM (support AU3): cfg-get-tcmex

Name cfg-get-tcmex

Function To query the status of TCM (support AU3).

Command Level System monitor

Available to User level

Version 5.21.01

cfg-get-tcm:Bid,Pid,Au4Id,Au3Id
Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 Au4Id: 1-X (Determine X according to the board type.)

4 Au3Id: 0-X

¡¡ TCACTIVITYEX
Output Format Bid Pid AU4ID AU3ID SrcEnable DstEnable
8 1 1 1 enable disable

Example :cfg-get-tcm:8,1,1,1

Precautions Only the N2-series boards support TCM.

Remarks

1.4.57 Set the AIS inserting status of TCM alarm event: cfg-set-tcalm2ais

Name cfg-set-tcalm2ais

Function To set the AIS inserting status of the TCM alarm event.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tcalm2ais:Bid, Pid, Au4Id, Flag

Input Format
Number of parameters: 4; repetitive parameter blocks.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 76 of 243

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
3 Au4Id: 1-X (Determine X according to the board type.)

Flag: disable or enable

4
Default: enable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tcalm2ais:1&2,1&&4,1&4, enable

Precautions

Remarks

1.4.58 Query the AIS inserting status of TCM alarm event: cfg-get-tcalm2ais

Name cfg-get-tcalm2ais

Function To query the AIS inserting status of the TCM alarm event.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tcalm2ais:Bid, Pid, Au4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 Au4Id: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-tcalm2ais:1&2,1&&4,1&4

Precautions

Remarks

1.4.59 Set the hardware REG: cfg-set-hardreg

Name cfg-set-hardreg

Function To set the hardware REG.

Command Level System operation

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 77 of 243

Available to User level

Version 5.21.01

:cfg-set-hardreg:Bid, Pid, hardreg

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

hardreg :
3 Enable
Disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-hardreg:6,1,enable

Precautions This command applies to the 10G/2.5G SDH line board.

Remarks

1.4.60 Query the hardware REG permission status: cfg-get-hardreg

Name cfg-get-hardreg

Function To query the hardware REG permission status.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-hardreg:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-hardreg:6,1

Precautions

Remarks

1.4.61 Set the VC4 mode: cfg-set-vc4mode

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 78 of 243

Name cfg-set-vc4mode

Function To set the VC4 mode.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-vc4mode:Bid, Pid, Au4Id, vc4mode

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters 3 Au4Id: 1-X (Determine X according to the board type.)

vc4mode:
term (terminal)
4 pass (pass)
auto (automatic)
default value:auto

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vc4mode: 4,1,1,term

Precautions

Remarks

1.4.62 Query the VC4 mode: cfg-get-vc4mode

Name cfg-get-vc4mode

Function To query the VC4 mode.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc4mode:Bid, Pid, Au4Id

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16 (40G XCS); 1-8, 11-17 (80G XCS)

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 Au4Id: 1-X (Determine X according to the board type.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 79 of 243

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-vc4mode:4,1,1

Precautions

Remarks

1.5 Commands for Configuring Tributary board Properties

1.5.1 Set BIP threshold for the path bit error: cfg-set-bipth

Name cfg-set-bipth

To set BIP threshold for the path bit error.

Function
This command is applicable to the tributary boards and Ethernet boards.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-bipth:Bid, Pid, th-type,over-th,sd-th

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

th-type (Threshold types):

3 vc3b3th
Input Parameters bip2th

over-th (see Remarks):

4 2-7 (for VC3B3)£¬ 3-7(for BIP2)
Default: 7£¨1.0E-3£©

sd-th (see Remarks):

5 1-6 (for VC3B3)£¬ 2-6(for BIP2)
Default: 4 £¨1.0E-6£©

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bipth:4,1&2,bip2th,6,3

Precautions The OVER threshold must be higher than the SD threshold.

Threshold level for the bit error:

1£>1.0E-9
2£>1.0E-8
3£>1.0E-7
Remarks
4£>1.0E-6
5£>1.0E-5
6£>1.0E-4
7£>1.0E-3

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 80 of 243

1.5.2 Query the BIP threshold for the path bit error: cfg-get-bipth

Name cfg-get-bipth

To query the BIP threshold for the bit error.

Function
This command is applicable to the tributary boards and Ethernet boards.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bipth:Bid, Pid, th-type

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

th-type (threshold type):

3 vc3b3th
bip2th

Parameter location Parameter meaning and value

1 BID (Board id)

2 PATHID (Path id)

Output Format
3 TYPE (Threshold type)

4 OVER (OVER threshold )

5 SD (SD threshold)

:cfg-get-bipth:4,1,bip2
PATH BIP THRESHOLD
Example
BID PATHID TYPE OVER SD
4 1 bip2th 6 3

Precautions

Remarks

1.5.3 Path bit error test: cfg-set-bittest

Name cfg-set-bittest

Function To test the path bit error.

Command Level System maintenance

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 81 of 243

:cfg-set-bittest:Bid, Pid, action, dir,mode,time

Input Format
Number of parameters: 6; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

3 Action: 0 (stop) , 1 (start)

dir (Test Direction):

Input Parameters 4 1 (corss direction)
2 (TU / LIU direction)

mode (Test Mode):

5 1 (Short time test: report the test result every second)
2 (Long time test: report the test result every minute)

time (Test Time):

6 0-255(Unit: second for the short time test; 10 minutes for the
long time test)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-bittest:4,1,0,1,1,5

Precautions This command is delivered directly to the board. Therefore, the board must be in position.

Remarks

1.5.4 Set the UNEQ inserting status in the case of LOS or path not in use: cfg-set-almuneq

Name cfg-set-almuneq

To set the UNEQ inserting status in the case of LOS or path not in use.
Function
This command is applicable to the tributary boards and Ethernet boards.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-almuneq:Bid, Pid, Eid, Flag

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2~5, 13~16

2 Pid: 1-16 (for TU boards), 1-8 (for Ethernet boards)

Input Parameters
Eid: Value Meaning
talos 2M analog signal lost (caused by cases like loose
3 cable)
pnouse path not in use
rlos Received singal lost (for Ethernet boards)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 82 of 243

flag: Value Meaning

disable (not insert UNEQ)
4
enable (insert UNEQ)
Default: disable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

:cfg-set-almuneq:11,5,pnouse,enable
Example
Set that Path 5 of Slot 11 is not in use, and insert LP_UNEQ into the path.

Precautions

Remarks

1.5.5 Query the UNEQ inserting status in the case of LOS or path not in use: cfg-get-almuneq

Name cfg-get-almuneq

To query the UNEQ inserting status in the case of LOS or path not in use.
Function
This command is applicable to the TU boards and Ethernet boards.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-almuneq:Bid, Pid, Eid

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

Bid: 5£¬6£¬9-12£¬15-18£¬21-24 (for TU boards)

1
5£¬6£¬9-12 (for Ethernet boards)

Input Parameters 2 Pid: 1-16 (for TU boards) £»1-8 (for Ethernet boards)

Eid: Value Meaning

talos 2M analog signal lost (caused by cases like loose
3 cable)
pnouse path not in use
rlos Received singal lost (for Ethernet boards)

Parameter location Parameter meaning and value

1 BID (Board id)

2 PATHID (Path id)

Output Format
3 ALM

FALG (Inserted flag):

Value Meaning
4
disable (not insert UNEQ)
enable (insert UNEQ)

:cfg-get-almuneq:10,1,pnouse
TU-INS-UNEQ
Example
BID PATHID ALM FLAG
10 1 pnouse enable

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 83 of 243

Precautions ¡¡

Remarks V1.0R002 supports the Ethernet network.

1.5.6 Query the impedance of the path cable: cfg-get-e1eq

Name cfg-get-e1eq

Function To query the impedance of the path cable.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-e1eq:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

:cfg-get-e1eq:4,1
TU E1EQ
Output Format
BID PATHID E1EQ
4 1 75ohm

Example :cfg-get-e1eq:4,1

Precautions

Remarks

1.5.7 Set the to-be-sent J2 bytes: cfg-set-stj2

Name cfg-set-stj2

Function To set the to-be-sent J2 bytes.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-stj2:Bid, Pid, tj2

Input Format
Number of parameters: 3; repetitive parameter blocks.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 84 of 243

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

tj2:
3
default value: " HuaWei SBS "

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stj2:4,1&&2£¬" HuaWei SBS "

Default: ¡° HuaWei SBS ¡±(One space at the beginning and five spaces at the end)
Precautions The board software determines that the bit7 of the first byte of J2 is 1; the bit7 of the last 15 bytes of J2 should
not be 1.

Remarks

1.5.8 Query the to-be-sent J2 bytes: cfg-get-stj2

Name cfg-get-stj2

Function To query the to-be-sent J2 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stj2:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

:cfg-get-stj2:2,1
TU-STJ2
Output Format Bid Pid J2VALUE
2 1 HuaWei SBS
Total records :1

Example :cfg-get-stj2:2,1

Precautions ¡¡

Remarks ¡¡

1.5.9 Set the receivable J2 bytes: cfg-set-srj2

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 85 of 243

Name cfg-set-srj2

Function To set the receivable J2 bytes.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-srj2:Bid, Pid, rj2

Input Format
Number of parameters: 3; repetitive parameter blocks..

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

rj2: receivable J2 bytes;

3
default value: " HuaWei SBS "

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srj2:4,1&&4£¬" HuaWei SBS "

Default: ¡° HuaWei SBS ¡±(One space at the beginning and five spaces at the end)
Precautions The board software determines that the bit7 of the first byte of J2 is 1; the bit7 of the last 15 bytes of J2 should
not be 1.

Remarks

1.5.10 Query the receivable J2 bytes: cfg-get-srj2

Name cfg-get-srj2

Function To query the receivable J2 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srj2:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

:cfg-get-srj2:2,1
TU-SRJ2
Output Format Bid Pid J2VALUE
2 1 HuaWei SBS
Total records :1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 86 of 243

Example :cfg-get-srj2:2,1

Precautions ¡¡

Remarks ¡¡

1.5.11 Query the received J2 bytes: cfg-get-rj2

Name cfg-get-rj2

Function To query the received J2 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rj2:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format

Example :cfg-get-rj2:4,1

Precautions ¡¡

Remarks ¡¡

1.5.12 Set the to-be-sent V5 byte: cfg-set-stv5

Name cfg-set-stv5

Function To set the to-be-sent V5 byte.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-stv5:Bid, Pid, Stv5

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 87 of 243

2 Pid: 1-X (Determine X according to the board type.)

3 V5

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-stv5:4,1&&4£¬0x04

Precautions

Remarks

1.5.13 Query the to-be-sent V5 byte: cfg-get-stv5

Name cfg-get-stv5

Function To query the to-be-sent V5 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stv5:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Parameter location Parameter meaning and value

1 Bid
Output Format
2 Pid

3 V5

Example

Precautions ¡¡

Remarks ¡¡

1.5.14 Set the receivable V5 byte: cfg-set-srv5

Name cfg-set-srv5

Function To set the receivable V5 byte.

Command Level System operation

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 88 of 243

Version 5.21.01

:cfg-set-srv5:Bid, Pid, Srv5

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 V5

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-srv5:4,1&&4£¬0x04

Precautions

Remarks

1.5.15 Query the receivable V5 byte: cfg-get-srv5

Name cfg-get-srv5

Function To query the receivable V5 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-srv5:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Parameter location Parameter meaning and value

1 Bid
Output Format
2 Pid

3 V5

Example

Precautions ¡¡

Remarks ¡¡

1.5.16 Query the received V5 byte: cfg-get-rv5

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 89 of 243

Name cfg-get-rv5

Function To query the received V5 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rv5:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Parameter location Parameter meaning and value

1 Bid
Output Format
2 Pid

3 V5

Example

Precautions ¡¡

Remarks ¡¡

1.5.17 Set the status of path: cfg-set-pathused

Name cfg-set-pathused

Function To set the status of path (use or unuse).

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-pathused:Bid, pid,flag
Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters Pid: 1-X (Determine X according to the board type; repetitive
2
parameter blocks.)

flag: use or unuse

3
Ddefault: use

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 90 of 243

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-pathused:4,1&&16,use

Precautions

Remarks

1.5.18 Query the status of path: cfg-get-pathused

Name cfg-get-pathused

Function To query the status of path (use or unuse).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-pathused:Bid,pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters
Pid: 1-X (Determine X according to the board type; repetitive
2
parameter blocks.)

Output Format

:cfg-get-pathused:4,1
TU-PATHUSED
Example
BID PATHID FLAG
4 1 use

Precautions ¡¡

Remarks ¡¡

1.5.19 Set the path retiming clock: cfg-set-retiming

Name cfg-set-retiming

Set the path retiming clock. This function mainly applies to places with poor tributary signal clock quality, and
Function thus needing to use an external clock imported by the cross-connect board as the retiming clock for the tributary
paths.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-retiming:Bid, pid,flag

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 91 of 243

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters flag:

flag:
noret Not use retiming clock
3 liu Use the LIU clock as the retiming clock
xc Use the cross-connect (external) clock as the
retimingclock
Default: noret

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-retiming:4,1,xc

Precautions ¡¡

Applicable to PQ1 and PQM. The tributary mapping chip provides the user an optionalPDH signal to output the
retiming FIFO. Instead of using the clock outputted by the internal phase-locked loop, the user can choose to
Remarks
use the external clock ReTimingClk (imported by the cross-connect board) or the uplink 2M clock TxClk (from
the tributary board) of each tributary path as the standard clock for outputting E1 signals.

1.5.20 Query the path retiming clock: cfg-get-retiming

Name cfg-get-retiming

Function To query the path retiming clock.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-retiming:Bid,pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Parameter location Parameter meaning and value

1 Bid

2 Pid
Output Format
Retiming clock:
Value Meaning
3 noret Not use retiming clock
liu Use the LIU clock as the retiming clock
xc Use the cross-connect (external) clock as the retiming

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 92 of 243

clock

:cfg-get-retiming:40,1
PATH RETIMING CLOCK
Example
BID PATHID ¡¡CLOCK
4 1 xc

Precautions

Remarks

1.5.21 Set the path sending overhead: cfg-set-tpoh

Name cfg-set-tpoh

To set the path sending overhead bytes V5, N2 and K4.

Function
This command is applicable to the TU boards and Ethernet boards.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-set-tpoh:Bid, pid,level,ohpos,value
Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters 3 Path level: vc12, vc3

Ohpos:
4 v5,n2,k4 (for VC12)
c2,g1,f2,f3,k3,n1 (for VC3)

5 Value: 0-255

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tpoh:4,1,vc12,v5,4

Precautions The value of V5 can only be used to set b5b6b7.

Remarks V1.0R002 supports the Ethernet network.

1.5.22 Query the path sending overhead: cfg-get-tpoh

Name cfg-get-tpoh

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 93 of 243

Function To query the path sending overhead bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpoh:Bid,pid,level,ohpos
Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 Path level: vc12, vc3

4 Ohpos: c2,g1,f2,f3,k3,n1,v5,n2,k4

Output Format

Example :cfg-get-tpoh:4,1,vc12,v5

Precautions This command is delivered directly to the board. Therefore, the board must be in position.

Remarks This command is applicable to the tributary boards and Ethernet boards.

1.5.23 Query the path receiving overhead: cfg-get-rpoh

Name cfg-get-rpoh

Function To query the path receiving overhead bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rpoh:Bid,pid,level,ohpos
Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

3 Path level: vc12, vc3

4 Ohpos: c2,g1,f2,f3,k3,n1,v5,n2,k4

Output Format

Example :cfg-get-rpoh:4,1,vc12,v5

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 94 of 243

Precautions This command is delivered directly to the board. Therefore, the board must be in position.

Remarks This command is applicable to the tributary boards and Ethernet boards.

1.5.24 Set the path master downlink bus: cfg-set-defbus

Name cfg-set-defbus

Function To set the path master downlink bus.

Command Level System debugging

Available to Customer service level

Version 5.21.01

:cfg-set-defbus:Bid, pid,bus
Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 2-5, 13-16

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

Bus:
a (bus A)
3
b (bus B)
Default: a

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-defbus:4,1&&16,b

Precautions ¡¡

Remarks ¡¡

1.5.25 Query the path master downlink bus: cfg-get-defbus

Name cfg-get-defbus

Function To query the path master downlink bus.

Command Level System debugging

Available to Internal level

Version 5.21.01

:cfg-get-defbus:Bid,pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 2-5, 13-16

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 95 of 243

2 Pid: 1-X (Determine X according to the board type.)

Output Format

:cfg-get-defbus:4,1
PATH DEFAULT BUS
Example
BID PATHID BUS
4 1 b

Precautions ¡¡

Remarks ¡¡

1.5.26 Query the path working downlink bus: cfg-get-dropbus

Name cfg-get-dropbus

To query the path working downlink bus.

Function In the circumstances with path protection, the actual downlink bus used by the path (namely, the working bus)
might be inconsistent with the mastery bus. That is, path switchover occurs.

Command Level System debugging

Available to Customer service level

Version 5.21.01

:cfg-get-dropbus:Bid,pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 2-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format

:cfg-get-dropbus:4,1
PATH DROP BUS
Example
BID PATHID BUS
41a

Precautions ¡¡

Remarks ¡¡

1.5.27 Set the reporting mode of the bus alarm: cfg-set-busalm

Name cfg-set-busalm

To set the reporting mode of the bus alarm.

Function In normal circumstances, the board reports the working bus alarms only. However, the non-working bus alarms
can also be set for debugging and maintenance.

Command Level System maintenance

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 96 of 243

Available to Customer service level

Version 5.21.01

:cfg-set-busalm:Bid, pid, flag

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters
flag:
both- Enable alarms of the two buses.
drop- Enable the working bus alarms. (Default)
3
nodrop- Enable the non-working bus alarms.
abus- Enable the A (UP) bus alarms.
bbus- Enable the B (DOWN) bus alarms.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

:cfg-set-busalm:9,1&&16,both
Example
Enable the alarms of the two buses of the paths 1~16 on Slot 9.

Precautions This command requires that the board be in position.

Remarks ¡¡

1.5.28 Query the reporting mode of the bus alarm: cfg-get-busalm

Name cfg-get-busalm

Function To query the reporting mode of the bus alarm.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-get-busalm:Bid,pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format

Example :cfg-get-busalm:10,1

Precautions

Remarks ¡¡

1.5.29 Set the to-be-sent J1 bytes of VC3: cfg-set-vc3stj1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 97 of 243

Name cfg-set-vc3stj1

Function To set the to-be-sent J1 bytes of vc3.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vc3stj1:Bid, Pid, J1mode, J1value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

J1mode:
0 SDH mode (The bit7 of the first and only the first byte of
the J1 byte sequence is 1.)
Input Parameters 3 1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default£º1

J1value£º
If the j1 protocol mode adopts 0 and 1, J1 is a character string
not more than 16 bytes.
4
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default£º¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set- vc3stj1:6,1,1&&16,1," HuaWei SBS "

If the j1 protocol mode adopts 0 and 1, the length of the j1 character string can be more than 16 bytes, while
only the former 16 characters are valid.
Precautions default¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end)
The to-be-sent J1 bytes can be set for the VC12 service; for the VC3 service, the low order services can be set
while the high order services cannot.

Remarks

1.5.30 Query the to-be-sent J1 bytes of VC3: cfg-get-vc3stj1

Name cfg-get- vc3stj1

Function To query the to-be-sent J1 bytes of vc3.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-vc3stj1:Bid, Pid

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 98 of 243

Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-srj1:6,1,1&&16

Precautions

Remarks

1.5.31 Set the receivable J1 bytes of VC3: cfg-set-vc3srj1

Name cfg-set- vc3srj1

Function To set the receivable J1 bytes of VC3.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set- vc3srj1:Bid, Pid, J1mode, J1value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

J1mode:
0 SDH mode (The bit7 of the first and only the first byte of
the J1 byte sequence is 1.)
Input Parameters 3 1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)
Default£º1

J1value£º
If the j1 protocol mode adopts 0 and 1, J1 is a character string
not more than 16 bytes.
4
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default£º¡° Huawei SBS ¡±

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vc3srj1:6,1,1&&16,1," HuaWei SBS "

Precautions

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 99 of 243

1.5.32 Query the receivable J1 bytes of VC3: cfg-get-vc3srj1

Name cfg-get-vc3srj1

Function To query the receivable J1 bytes of VC3.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc3srj1:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get- vc3srj1:6,1,1&&16

Precautions ¡¡

Remarks ¡¡

1.5.33 Query the received J1 bytes of VC3: cfg-get-vc3rj1

Name cfg-get-vc3rj1

Function To query the received J1 bytes of VC3.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc3rj1:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5, 13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-vc3rj1:6,1,1&&16

Precautions This command applies to the LU boards only.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 100 of 243

Remarks

1.5.34 Set the to-be-sent C2 byte of VC3: cfg-set-vc3stc2

Name cfg-set- vc3stc2

Function To set the to-be-sent C2 byte of VC3.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set- vc3stc2:Bid, Pid, C2value

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

C2value:
Value Meaning
uneq singal uneuipped
unsp non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s singnals,
asynchronously mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into
Input Parameters C--4
atm ATM mapping
man MAN (DQDB) mapping
fddi FDDI
3
ppp PPP
synsdl Simple data link mapping of the SDH self-
synchronizing scrambler
laps LAPS
setsdl Set and reset the simple data link mapping of the
scrambler
enet 10G Ethernet network signal mapping
gfp Changeable topological data connection mapping
resv Reserved
resvn1 Reseerved for the national use
resvn2 Reseerved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vc3stc2:6,1,4

Precautions

Remarks

1.5.35 Query the to-be-sent C2 byte of VC3: cfg-get-vc3stc2

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 101 of 243

Name cfg-get-vc3stc2

Function To query the to-be-sent C2 byte of VC3.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc3stc2:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16;

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-vc3stc2:6,1

Precautions

Remarks

1.5.36 Set the receivable C2 byte of VC3: cfg-set-vc3src2

Name cfg-set-vc3src2

Function To set the receivable C2 byte of VC3.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vc3src2:Bid, Pid, C2value

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

C2value:
Value Meaning
uneq singal uneuipped
unsp non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s singnals,
asynchronously mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into
C--4

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 102 of 243

atm ATM mapping

man MAN (DQDB) mapping
fddi FDDI
ppp PPP
synsdl Simple data link mapping of the SDH self-
synchronizing scrambler
laps LAPS
setsdl Set and reset the simple data link mapping of the
Input Parameters 3 scrambler
enet 10G Ethernet network signal mapping
gfp Changeable topological data connection mapping
resv Reserved
resvn1 Reseerved for the national use
resvn2 Reseerved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vc3src2:6,1,tugs

Precautions ¡¡

Remarks ¡¡

1.5.37 Query the receivable C2 byte of VC3: cfg-get-vc3src2

Name cfg-get-vc3src2

Function To query the receivable C2 byte of VC3.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc3src2:Bid, Pid
Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-vc3src2:6,1

Precautions ¡¡

Remarks ¡¡

1.5.38 Query the received C2 byte of VC3: cfg-get-vc3rc2

Name cfg-get-vc3rc2

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 103 of 243

Function To query the received C2 byte of VC3.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vc3rc2:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format ¡¡

Example :cfg-get-vc3rc2:6,1

Precautions This command is delivered directly to the board. Therefore, the board must be in position.

Remarks ¡¡

1.5.39 Set the status of the input balance: cfg-set-selreqb

Name cfg-set-selreqb

Function To set the status of the input balance.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-selreqb:Bid, Pid, Reqb

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16
Input Parameters
2 Pid: 1-X (Determine X according to the board type.)

3 Reqb: unbalance (default) or balance

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-selreqb:2,1,1

Precautions Only some tributary boards support this command.

Remarks ¡¡

1.5.40 Query the status of the input balance: cfg-get-selreqb

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 104 of 243

Name cfg-get-selreqb

Function To query the enable/disable status of the input balance

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-selreqb:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format ¡¡

Example :cfg-get-selreqb:2,1

Precautions Only some tributary boards support this command.

Remarks ¡¡

1.5.41 Set the status of the output balance: cfg-set-selteqb

Name cfg-set-selteqb

Function To set the status of the output balance.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-selteqb:Bid, Pid, Teqb

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16

Input Parameters 2 Pid: 1-X (Determine X according to the board type.)

Teqb:
3 1- Cable length (0~250m)
2- Cable length (250~500m)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-selteqb:2,1,1

Precautions Only some tributary boards support this command.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 105 of 243

Remarks ¡¡

1.5.42 Query the status of the output balance: cfg-get-selteqb

Name cfg-get-selteqb

Function To query the status of the output balance.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-selteqb:Bid, Pid
Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-selteqb:1,1

Precautions Only the tributary boards ssn1pqm, ssn1pl3 and ssn1pd3 support this command.

Remarks ¡¡

1.5.43 Set the service type: cfg-set-payloadtype

Name cfg-set-payloadtype

Function To set the service type.

Command Level System operation

Available to User level

Version 5.21.01

: cfg-set-payloadtype:Bid, Pid,Type
Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters

Type:
e1: E1 services
t1: T1 services (PQM supports both E1 and T1, but adopts T1
as the default.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 106 of 243

e3: E3 services
t3: T3 Services (PL3 and PD3 support both E3 and T3, but
adopt T3 as the default.)
3
e4: 140M services
stm1: STM-1 services (SPQ4 supports both e4 and stml, but
adopts e4 as the default.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example : cfg-set-payloadtype:1,1,t1

Precautions Only some boards support this command.

Remarks ¡¡

1.5.44 Query the service type: cfg-get-payloadtype

Name cfg-get-payloadtype

Function To query the service type.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get- payloadtype:Bid, Pid

Input Format
Number of parameters: 2; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-get- payloadtype:1,1

Precautions Only some boards support this command.

Remarks

1.5.45 Set the service matching of the tributary board path: cfg-set-tumatch

Name cfg-set-tumatch

Function To set the service matching (transparent transmission/butting/frame structure) of the tributary board path.

Command Level System operation

Available to User level

Version 5.21.01

: cfg-set-tumatch:Bid,Pid,E1T1Cnct,T1Struct,E1Struct

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 107 of 243

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

3 E1T1Cnct: pass/connect/ connect-watch

Input Parameters
T1Struct:
4
tu-t1: d4, esf, slc96, f4, t1-unframed,t1-null

E1Struct:
5 tu-e1: pcm30, pcm31, pcm30crc, pcm31crc, e1-
unframed,e1-null

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tumatch:2,1,connect,d4,pcm31

Precautions Only the PQM board in R1 supports this command.

Remarks ¡¡

1.5.46 Query the service matching of the tributary board path: cfg-get-tumatch

Name cfg-get-tumatch

Function To query the service matching (transparent transmission/butting/frame structure) of the tributary board path.

Command Level System monitoring

Available to User level

Version 5.21.01

: cfg-get-tumatch:Bid,Pid
Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-5,13-16

2 Pid: 1-X (Determine X according to the board type.)

:cfg-get-tumatch:4,1
PATH PAYLOAD MATCH
Output Format
BID PATHID CONNECTMODE INTERFACE-FRAME MAPPING-FRAME
4 1 connect d4 pcm31crc

Example :cfg-get-tumatch:4,1

Precautions Only the PQM board in R1 supports this command.

Remarks ¡¡

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 108 of 243

1.6 Ethernet Boards Configuration Commands

Note: The name and format of some Ethernet properties commands are the same as that of the line board
or tributary board commands described above. These commands include:

Set the laser switch status:cfg-set-laser

Query the laser switch stutus: cfg-get-laser

Set the laser ALS switch status: cfg-set-als

Query the laser ALS switch status: cfg-get-als

Set the laser ALS time parameter: cfg-set-alstime

Query the laser ALS time parameter: cfg-get-alstime

Set the laser auto judgement of consistant testing status: cfg-test-als

Set the path BIP threshold: cfg-set-bipth

Query the path BIP threshold: cfg-get-bipth

1.6.1 Set the loop mode of the ethernet path: cfg-set-vcloop

Name cfg-set-vcloop

Function To set the loop mode of the Ethernet path.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcloop:Bid, XcLevel, PathId, LoopMode

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc3 path

Input Parameters
3 PathId: 1~48 for ssn1egs2, 1~12 for ssn1efs4 and ssn1efs0

LoopMode: loopin, loopout or noloop

4
Default: noloop

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-vcloop:7&8,vc3path,1&&12,loopin

Precautions

Remarks This command is delivered directly to the board. Therefore, the board must be in position.

1.6.2 Query the loop mode of the ethernet path: cfg-get-vcloop

Name cfg-get-vcloop

Function To query the loop mode of the Ethernet path.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 109 of 243

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-get-vcloop:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc3path

PathId: 0~48 for ssn1egs2, 0~12 for ssn1efs4 and ssn1efs0

3
(Full query supported; 0 for all paths)

Output Format

Example :cfg-get-vcloop:7,vc3path,0

Precautions

Remarks This command is delivered directly to the board. Therefore, the board must be in position.

1.6.3 Set the to-be-sent J1 bytes: cfg-set-vcstj1

Name cfg-set-vcstj1

Function To set the Ethernet to-be-sent J1 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcstj1:Bid, XcLevel, PathId, J1mode, J1value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3
1~12 for ssn1efs4 and ssn1efs0
Input Parameters
J0mode:

Value Meaning
0 SDH mode (The bit7 of the first and only the first byte of
4 the J0 byte sequence is 1.)
1 SDH mode (Adopt forcibly the CRC verification to
generate the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 110 of 243

Default: 1

J1value:
If the j1 protocol mode adoapts 0 and 1, J1 is a character string
not more than 16 bytes.
5
If the j1 protocol mode adopts 2, J1 is a character string not
more than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format ¡¡

Example :cfg-set-vcstj1:7,vc3path,1&&12,1," HuaWei SBS "

If the j1 protocol mode adopts 0 and 1, the length of the j1 character string can be more than 16 bytes. However,
Precautions only the former 16 bytes are valid.
Default: ¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end)

Remarks

1.6.4 Query the Ethernet to-be-sent J1 bytes: cfg-get-vcstj1

Name cfg-get-vcstj1

Function To query the Ethernet to-be-sent J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcstj1:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0
(Full query supported; 0 for all paths)

Output Format

Example :cfg-get-vcstj1:7&8,vc3path,0

Precautions

Remarks

1.6.5 Set the ethernet receivable J1 bytes: cfg-set-vcsrj1

Name cfg-set-vcsrj1

Function To set the Ethernet receivable J1 bytes.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 111 of 243

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcsrj1:Bid, XcLevel, PathId, J1mode, J1value

Input Format
Number of parameters: 5; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc3path

PathId: 1~48(vc3path) for ssn1egs2

3
1~24(vc3path) for ssn1efs4 and ssn1efs0

J0mode:

Value Meaning
Input Parameters 0 SDH mode (The bit7 of the first and only the first byte of the
J0 byte sequence is 1.)
4
1 SDH mode (Adopt forcibly the CRC verification to generate
the first byte.)
2 SONET mode (Configure the J1 value to 64 bytes.)

Default: 1

J1value:
If the j1 protocol mode adoapts 0 and 1, J1 is a character string
not more than 16 bytes.
5
If the j1 protocol mode adopts 2, J1 is a character string not more
than 64 bytes.
Default: ¡° Huawei SBS ¡±

Output Format ¡¡

Example :cfg-set-vcsrj1:8,vc3path,1&&12,1," HuaWei SBS "

If the j1 protocol mode adopts 0 and 1, the length of the j1 character string can be more than 16 bytes. However,
Precautions only the former 16 bytes are valid.
Default: ¡° HuaWei SBS ¡± (One space at the beginning and five spaces at the end)

Remarks

1.6.6 Query the ethernet receivable J1 bytes: cfg-get-vcsrj1

Name cfg-get-vcsrj1

Function To query the Ethernet receivable J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-vcsrj1:Bid, XcLevel, PathId

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 112 of 243

Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcsrj1:7&8,vc3path,0

Precautions

Remarks

1.6.7 Query the ethernet received J1 bytes: cfg-get-vcrj1

Name cfg-get-vcrj1

Function To query the Ethernet received J1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcrj1:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3
1~12 for ssn1efs4 and ssn1efs0

Output Format

Example :cfg-get-vcrj1:7&8,vc3path,12

Precautions

Remarks

1.6.8 Set the ethernet to-be-sent C2 byte: cfg-set-vcstc2

Name cfg-set-vcstc2

Function To set the Ethernet to-be-sent C2 byte.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 113 of 243

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcstc2:Bid, XcLevel, PathId, C2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter
Parameter meaning and value
location

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0

C2value:
Value Meaning
uneq singal uneuipped
unsp non-specific payload equipped
tugs TUG structure
tulock Lock TU
Input Parameters asyn 34.368Mbit/s and 44.736Mbit/s singnals, asynchronously mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into C--4
atm ATM mapping
man MAN (DQDB) mapping
fddi FDDI
4
ppp PPP
synsdl Simple data link mapping of the SDH self-synchronizing scrambler
laps LAPS
setsdl Set and reset the simple data link mapping of the scrambler
enet 10G Ethernet network signal mapping
gfp Changeable topological data connection mapping
resv Reserved
resvn1 Reseerved for the national use
resvn2 Reseerved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format ¡¡

Example :cfg-set-vcstc2:8,vc3path,1&&12,tugs

Precautions

Remarks

1.6.9 Query the ethernet to-be-sent C2 byte: cfg-get-vcstc2

Name cfg-get-vcstc2

Function To query the Ethernet to-be-sent C2 byte.

Command Level System monitoring

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 114 of 243

Version 5.21.01

:cfg-get-vcstc2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcstc2:7&8,vc3path,0

Precautions

Remarks

1.6.10 Set the ethernet receivable C2 byte: cfg-set-vcsrc2

Name cfg-set-vcsrc2

Function To set the Ethernet receivable C2 byte.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcsrc2:Bid, XcLevel, PathId, C2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter
Parameter meaning and value
location

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0

Input Parameters
C2value:
Value Meaning
uneq singal uneuipped
unsp non-specific payload equipped
tugs TUG structure
tulock Lock TU
asyn 34.368Mbit/s and 44.736Mbit/s singnals, asynchronously mapped into C-3
develop Mapping to be developed
a140 139.264Mbit/s signal, asynchronously mapped into C--4
atm ATM mapping
man MAN (DQDB) mapping

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 115 of 243

fddi FDDI
ppp PPP
synsdl Simple data link mapping of the SDH self-synchronizing scrambler
laps LAPS
setsdl Set and reset the simple data link mapping of the scrambler
enet 10G Ethernet network signal mapping
4 gfp Changeable topological data connection mapping
resv Reserved
resvn1 Reseerved for the national use
resvn2 Reseerved for the national use
test 0.181 test signal
ais VC-AIS (used for serial connection only)
Default: tugs

Output Format ¡¡

Example :cfg-set-vcsrc2:8,vc3path,1&&12,tugs

Precautions

Remarks

1.6.11 Query the ethernet receivable C2 byte: cfg-get-vcsrc2

Name Cfg-get-vcsrc2

Function To query the Ethernet receivable C2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcsrc2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcsrc2:7&8,vc3path,0

Precautions

Remarks

1.6.12 Query the ethernet received C2 byte: cfg-get-vcsrc2

Name cfg-get-vcrc2

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 116 of 243

Function To query the Ethernet received C2 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcrc2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 XcLevel: vc3path

PathId: 1~48 for ssn1egs2

3 1~12 for ssn1efs4 and ssn1efs0
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcrc2:7&8,vc3path,0

Precautions

Remarks

1.6.13 Set the ethernet to-be-sent J2 bytes: cfg-set-vcstj2

Name cfg-set-vcstj2

Function To set the Ethernet to-be-sent J2 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcstj2:Bid, XcLevel, PathId, J2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc12path
Input Parameters
PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and
3
ssn1efs0¡£

J2 value: A character string of 16 bytes

4
Default: ¡° Huawei SBS ¡±

Output Format ¡¡

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 117 of 243

Example :cfg-set-vcstj2:8,vc12path,1, " HuaWei SBS "

Default: ¡° HuaWei SBS ¡±(One space at the beginning and five spaces at the end)
Precautions The board software determines that the bit7 of the first byte of J2 is 1; the bit7 of the last 15 bytes of J2 should
not be 1.

Remarks

1.6.14 Query the ethernet to-be-sent J2 bytes: cfg-get-vcstj2

Name cfg-get-vcstj2

Function To query the Ethernet to-be-sent J2 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcstj2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0¡£

3
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcstj2:7&8,vc12path,0

Precautions

Remarks

1.6.15 Set the ethernet receivable J2 bytes: cfg-set-vcsrj2

Name cfg-set-vcsrj2

Function To set the Ethernet receivable J2 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcsrj2:Bid, XcLevel, PathId, J2value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 118 of 243

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc12path

Input Parameters PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and
3
ssn1efs0¡£

J2 value: A character string of 16 bytes

4
Default: ¡° Huawei SBS ¡±

Output Format ¡¡

Example :cfg-set-vcsrj2:8,vc12path,1," HuaWei SBS "

Default: ¡° HuaWei SBS ¡±(One space at the beginning and five spaces at the end)
Precautions The board software determines that the bit7 of the first byte of J2 is 1; the bit7 of the last 15 bytes of J2 should
not be 1.

Remarks

1.6.16 Query the ethernet receivable J2 bytes: cfg-get-vcsrj2

Name cfg-get-vcsrj2

Function To query the Ethernet receivable J2 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcsrj2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0¡£

3
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcsrj2:7&8,vc12path,0

Precautions

Remarks

1.6.17 Query the ethernet received J2 bytes: cfg-get-vcrj2

Name cfg-get-vcrj2

Function To query the Ethernet received J2 bytes.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 119 of 243

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcrj2:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

3 PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0

Output Format

Example :cfg-get-vcrj2:7&8,vc12path,1

Precautions

Remarks

1.6.18 Set the ethernet to-be-sent V5 bytes: cfg-set-vcstv5

Name cfg-set-vcstv5

Function To set the Ethernet to-be-sent V5 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcstv5:Bid, XcLevel, PathId, V5value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 XcLevel: vc12path
Input Parameters
PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and
3
ssn1efs0

V5: 0~13
4
Default: 2

Output Format ¡¡

Example :cfg-set-vcstv5:8,vc12path,1&&63,3

Precautions

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 120 of 243

Remarks

1.6.19 Query the ethernet to-be-sent V5 bytes: cfg-get-vcstv5

Name cfg-get-vcstv5

Function To query the Ethernet to-be-sent V5 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcstv5:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0

3
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcstv5:7&8,vc12path,0

Precautions

Remarks

1.6.20 Set the ethernet reveivable V5 bytes: cfg-set-vcsrv5

Name cfg-set-vcsrv5

Function To set the Ethernet receivable V5 bytes.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-vcsrv5:Bid, XcLevel, PathId, V5value

Input Format
Number of parameters: 4; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

3 PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 121 of 243

ssn1efs0

V5: 0~13
4
Default: 2

Output Format ¡¡

Example :cfg-set-vcsrv5:8,vc12path,1&&63,3

Precautions

Remarks

1.6.21 Query the ethernet reveivable V5 bytes: cfg-get-vcsrv5

Name cfg-get-vcsrv5

Function To query the Ethernet receivable V5 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-vcsrv5:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0

3
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcsrv5:7&8,vc12path,0

Precautions

Remarks

1.6.22 Query the ethernet reveived V5 bytes: cfg-get-vcrv5

Name cfg-get-vcrv5

Function To query the Ethernet received V5 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 122 of 243

:cfg-get-vcrv5:Bid, XcLevel, PathId

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters
2 XcLevel: vc12path

PathId: 1~252 for ssn1egs2, 1~63 for ssn1efs4 and ssn1efs0

3
(Full query supported; 0 for all paths.)

Output Format

Example :cfg-get-vcrv5:7&8,vc12path,0

Precautions

Remarks

1.7 Commands for Configuring Clock Board Properties

1.7.1 Query the current tracing clock source: cfg-get-cursyn
Name cfg-get-cursyn

Function To query the current tracing clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-cursyn:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-cursyn:9
CUR-SYN : 0xf101

Example :cfg-get-cursyn:9

Precautions This command requires that the board be in position.

Remarks

1.7.2 Query the current 2M tracing clock source: cfg-get-2mcursyn

Name cfg-get-2mcursyn

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 123 of 243

Function To query the current 2M tracing clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2mcursyn:Bid,SynTbl
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

Input Parameters
SynTbl: Clock source priority list of the 2M phase source
2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-2mcursyn:9,fir-2m-tbl
2M-CUR-SYN : fir-2m-tbl 0xf101

Example :cfg-get-2mcursyn:9,fir-2m-tbl

Precautions This command requires that the board be in position.

Remarks

1.7.3 Query the current tracing source and the corresponding S1 bytes: cfg-get-cursyns1

Name cfg-get-cursyns1

Function To query the current tracing source and the corresponding S1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-cursyns1:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-cursyns1:9
CUR-SYN-S1
Output Format
SYN-SOURCE S1-VALUE
0xf101 QL_DNU
Total records :1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 124 of 243

Example :cfg-get-cursyns1:9

Precautions

Remarks

1.7.4 Query the 2M current tracing source and the corresponding S1 bytes: cfg-get-2mcursyns1

Name cfg-get-2mcursyns1

Function To query the 2M current tracing source and the corresponding S1 bytes.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2mcursyns1:Bid, SynTbl
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynTbl: Clock source priority list of the 2M phase source
2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-2mcursyns1:9, fir-2m-tbl
Output Format 2M-CUR-SYN-S1
SYN-TABLE SYN-SOURCE S1-VALUE
fir-2m-tbl 0xf101 QL_DNU
Total records :1

Example :cfg-get-2mcursyns1:9, fir-2m-tbl

Precautions

Remarks

1.7.5 Query the S1 bytes corresponding to all sources in the system priority list: cfg-get-alls1

Name cfg-get-alls1

Function To query the S1 bytes corresponding to all sources in the system priority list.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-alls1:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 125 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-alls1:9
Output Format ALL-SYN-S1
SYN-SOURCE S1-VALUE
0xf101 QL_DNU
Total records :1

Example :cfg-get-alls1:9

Precautions

Remarks

1.7.6 Query the S1 bytes corresponding to all sources in the 2M priority list: cfg-get-2malls1

Name cfg-get-2malls1

Function To query the S1 bytes corresponding to all sources in the 2M priority list.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2malls1:Bid, SynTbl
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynTbl: Clock source priority list of the 2M phase source
2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-2malls1:9,fir-2m-tbl
ALL-2MSYN-S1
Output Format
SYN-TABLE SYN-SOURCE S1-VALUE
fir-2m-tbl 0x0701 QL_DNU
fir-2m-tbl 0x0d01 QL_DNU
Total records :2

Example :cfg-get-alls1:9,fir-2m-tbl

Precautions

Remarks

1.7.7 Query the currently existing sources in the priority list: cfg-get-synexist

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 126 of 243

Name cfg-get-synexist

Function Query the currently existing sources in the priority list.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get- synexist:Bid, SynTbl

Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynTbl: The clock source priority list
syn-tbl: The system clock priority list
2
fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-synexist:9,syn-tbl
Output Format SYN- EXIST-VALID
SYN-TABLE SYN-SOURCE
syn-tbl 0xf101
Total records :1

Example :cfg-get-synexist:9,syn-tbl

Precautions

Remarks

1.7.8 Set the priority list of the system clock source: cfg-set-synclass
Name cfg-set-synclass

Function To set the priority list of the system clock source.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-synclass:Bid, SyncNum, Sync1, Sync2,...

Input Format
Number of parameters not specified; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SyncNum: Number of clock sources: N; 1-59(40G XCS)£¬1-95
2
(80G XCS)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 127 of 243

3 Number of No. 1 clock source: See Precautions for the value.

... ...

N+2 Number of No. N clock source: See Precautions for the value.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-synclass:9, 2, 0x0501, 0xf101

1. Rules for numbering the clock sources:

Every clock source is a double-byte hexadecimal number starting with 1. The high byte indicates
the line board ID (0x01~0x11), while the low byte for the optical interface number. The number
of the No. 1 external source is 0xf001, and 0xf002 for the No.2 external source; the number of
the internal source is 0xf101.
2. Please pay attention to the difference between the hexadecimal and the decimal system. For
example, the No. 15 board ID is expressed as 0x0f.
Precautions 3. The board with the board ID corresponding to the clock source number must be installed and in the ACTIVE
status.
4. In terms of boards with multiple optical interfaces, it is not allowed to adopt different optical interface as the
clock source in different priority lists (such as the two-path 2MPLL priority list and the system clock source
priority list). For example, assume that the board with ID as 1 has four optical interfaces, and the No.1 optical
interface is configured as the clock source. If the clock source 0x0101 is configured when creating the system
clock priority list, it is not allowed to configure the No. 2, No.3 or No.4 optical interface as the clock source when
creating the priority list exported by the external retiming clock. However, 0x0101 can be configured as the clock
source.

Remarks

1.7.9 Set the clock source priority list of the 2M phase source: cfg-set-2msynclass
Name Cfg-set-2msynclass

Function To set the clock source priority list of the 2M phase source.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-2msynclass:Bid, SynTbl, SyncNum, Sync1, Sync2,...

Input Format
Number of parameters not specified; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

SynTbl: Clock source priority list of the 2M phase source

2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list
Input Parameters
SyncNum: Number of the clock sources: N£¬1-59(40G XCS)
3
£¬1-95(80G XCS)

4 Number of No.1 clock source: See Precautions for the value.

... ...

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 128 of 243

N+3 Number of No.N clock source: See Precautions for the value.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-2msynclass:9, fir-2m-tbl, 2, 0x0501, 0x0601

1. Rules for numbering the clock sources:

Every clock source is a double-byte hexadecimal number starting with 1. The high byte indicates
the line board ID (0x01~0x11), while the low byte for the optical interface number. The number of
the No. 1 external source is 0xf001, and 0xf002 for the No.2 external source; the number of the
internal source is 0xf101.
2. Please pay attention to the difference between the hexadecimal and the decimal system. For
example, the No. 15 board ID is expressed as 0x0f.
3. The board with the board ID corresponding to the clock source number must be installed and in the ACTIVE
status.
4. Requirements of the 2M phase source: The clock source in the 2MPLL priority list can only be
Precautions the line source or internal source. Please note that the line source and internal source cannot co-
exist in the priority list.
5. The 2MPLL priority list and the system clock priority list are mutually independent. The
numbering of the clock source can be the same as that in the priority list for configuring the
system clock. The priority list exported by the external retiming clock adopts the internal source
by default.
6. In terms of boards with multiple optical interfaces, it is not allowed to adopt different optical interface as the
clock source in different priority lists (such as the two-path 2MPLL priority list and the system clock source priority
list). For example, assume that the board with ID as 1 has four optical interfaces, and the No.1 optical interface is
configured as the clock source. If the clock source 0x0101 is configured when creating the system clock priority
list, it is not allowed to configure the No. 2, No.3 or No.4 optical interface as the clock source when creating the
priority list exported by the external retiming clock. However, 0x0101 can be configured as the clock source.

Remarks

1.7.10 Query the clock source priority list: cfg-get-synclass

Name cfg-get-synclass

Function To query the clock source priority list.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synclass:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-synclass:9
SYN-CLASS : 3 0x0701 0x0d01 0xf101

Example :cfg-get-synclass:9

Precautions

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 129 of 243

Remarks

1.7.11 Query the clock source priority list of the 2M phase source: cfg-get-2msynclass

Name cfg-get-2msynclass

Function To query the clock source priority list of the 2M phase cource.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2msynclass:Bid, SynTbl
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynTbl: Clock source priority list of the 2M phase source
2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-2msynclass:9, fir-2m-tbl
2M-SYN-CLASS : fir-2m-tbl 1 0xf101

Example :cfg-get-2msynclass:9, fir-2m-tbl

Precautions

Remarks

1.7.12 Execute the external switch and reset commands of the system clock priority list: cfg-set-
synextsw

Name cfg-set-synextsw

Function To execute the external switch and reset commands of the system clock priority list.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-synextsw:Bid, SwitchCmd, SynId

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 130 of 243

SwitchCmd: external switch command

Value Meaning
2
0 Reset the external switch commands (auto switch mode)
Input Parameters 1 Manual switch
2 Force switch

3 SynId: ID of the clock source with switch

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-synextsw:9,1,0x0101

The clock source should be that recorded in the priority list.

Precautions When the external switch command is 0 (namely, Reset the external switch commands), the followed clock
source parameters are invalid.

Remarks

1.7.13 Execute the external switch and reset commands of the 2M clock priority list: cfg-set-
2msynextsw

Name cfg-set-2msynextsw

Function To execute the external switch and reset commands of the 2M clock priority list.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-2msynextsw:Bid,syn-tbl,SwitchCmd,SynId
Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

SynTbl: Clock source priority list of the 2M phase source

2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list
Input Parameters
SwitchCmd: external switch command

Value Meaning
3
0 Reset the external switch commands (auto switch mode)
1 Manual switch
2 Force switch

4 SynId: ID of the clock source with switch

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-2msynextsw:9, fir-2m-tbl,1,0x0101

The clock source should be that recorded in the priority list.

Precautions When the external switch command is 0 (namely, Reset the external switch commands), the followed clock source
parameters are invalid.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 131 of 243

Remarks

1.7.14 Query the switching status of the clock source in the system clock priority list: cfg-get-
synswstatus

Name cfg-get-synswstatus

To query the switching status of the clock source in the priority list, including the switching mode and the
Function
switched clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synswstatus:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-synswstatus:9
Output Format SYN-SWITCH-STATUS
SWITCH-STATUS CURRENT-SYN
syn-auto 0xf101
Total records :1

Example :cfg-get-synswstatus:9

Precautions ¡¡

Remarks

1.7.15 Query the switching status of the clock source in the 2M phase source priority list: cfg-
get-2msynswstatus

Name cfg-get-2msynswstatus

To query the switching status of the clock source in the 2M phase source priority list, including the switching
Function
mode and the switched clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2msynswstatus:Bid, SynTbl
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 132 of 243

SynTbl: Clock source priority list of the 2M phase source

Input Parameters 2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-2msynswstatus:9, fir-2m-tbl
Output Format 2MSYN-SWITCH-STATUS
SYN-TABLE SWITCH-STATUS CURRENT-SYN
fir-2m-tbl syn-auto 0xf101
Total records :1

Example :cfg-get-2msynswstatus:9, fir-2m-tbl

Precautions ¡¡

Remarks

1.7.16 Set the action for the 2M clock source failure: cfg-set-2mpllsynlosaction

Name cfg-set-2mpllsynlosaction

Function To set the action for the 2M clock source failure.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-2mpllsynlosaction:Bid, SynTbl, Action

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

Input Parameters SynTbl: Clock source priority list of the 2M phase source
¡¡ 2 fir-2m-tbl: The first 2M phase source priority list
¡¡ sec-2m-tbl: The second 2M phase source priority list

Actions in the case of 2MPLL failure:

0: The S1 byte output by 2M is not usable (Send 0X0F)
3
1: Send AIS
2: Disable the output

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-2mpllsynlosaction:9,fir-2m-tbl,1

Precautions ¡¡

Remarks ¡¡

1.7.17 Query the action for the 2M clock source failure: cfg-get-2mpllsynlosaction

Name cfg-get-2mpllsynlosaction

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 133 of 243

Function To query the action for the 2M clock source failure.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-2mpllsynlosaction: Bid, SynTbl

Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynTbl: Clock source priority list of the 2M phase source
2 fir-2m-tbl: The first 2M phase source priority list
sec-2m-tbl: The second 2M phase source priority list

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-2mpllsynlosaction: 9, fir-2m-tbl
2MPLL-SYNLOS-ACTION : fir-2m-tbl 2

Example :cfg-get-2mpllsynlosaction: 9, fir-2m-tbl

Precautions

Remarks

1.7.18 Enable/Disable the configured clock source to be used in the switching: cfg-set-synenable

Name cfg-set-synenable

Function Enable/Disable the configured clock source to be used in the switching.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-synenable:Bid, SynId, Flag

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
2 SynId: Clock source ID

3 Flag: disable or enable

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-synenable:9,0x0101, disable

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 134 of 243

Precautions The clock source must be that recorded in the priority list instead of the internal source.

Remarks

1.7.19 Query the status (enable/disable) of the configured clock source to be used in the
switching: cfg-get-synenable

Name cfg-get-synenable

Function To query the status (enable/disable) of the configured clock source to be used in the switching.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synenable:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-synenable:9
Output Format SYN-ENABLE
SYN-SOURCE ENABLE-FLAG
0xf101 enable
Total records :1

Example :cfg-get-synenable:9

Precautions

Remarks

1.7.20 Set the receiving time slot for the external source S1 byte: cfg-set-exts1inslot

Name cfg-set-exts1inslot

Function To set the receiving time slot (TS) for the external source S1 byte.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-exts1inslot:Bid, SynId, S1Slot

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 135 of 243

2 SynId: 0xf001 or 0xf002

S1Slot: Receiving TS of the S1 byte

Input Parameters value TS

0 £> 4
3
1 £> 5
2 £> 6
3 £> 7
4 £> 8

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-exts1inslot:9,0xf001,1

Precautions

Remarks

1.7.21 Query the receiving TS of the external source S1 byte: cfg-get-exts1inslot

Name cfg-get-exts1inslot

Function To query the receiving TS of the external source S1 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-exts1inslot:Bid, SynId
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 9 or 10

2 SynId: 0xf001 or 0xf002

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-exts1inslot:9,0xf001
Output Format EXT-SYN-S1-SLOT
EXT-SYN S1-SLOT
0xf001 0
Total records :1

Example :cfg-get-exts1inslot:9,0xf001

Precautions

Remarks

1.7.22 Set the output TS for the external source S1 byte: cfg-set-exts1outslot

Name cfg-set-exts1outslot

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 136 of 243

Function To set the output TS for the external source S1 byte.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-exts1outslot:Bid, SynId, S1Slot

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

2 SynId: 0xf001 or 0xf002

S1Slot: Output TS of the S1 byte

Input Parameters
value TS
0 £> All TS¡¯ s
3 1 £> 4
2 £> 5
3 £> 6
4 £> 7
5 £> 8

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-exts1outslot:9,0xf001,1

Precautions

Remarks

1.7.23 Query the output TS of the external source S1 byte: cfg-get-exts1outslot

Name cfg-get-exts1outslot

Function To query the output TS of the external source S1 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-exts1outslot:Bid, SynId
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 9 or 10

2 SynId: 0xf001 or 0xf002

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-exts1outslot:9,0xf001

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 137 of 243

EXT-S1-INSLOT
SYN-SOURCE S1SLOT
Output Format
0xf001 0
Total records :1

Example :cfg-get-exts1outslot:9,0xf001

Precautions ¡¡

Remarks

1.7.24 Enable/Disable switching in the sequence of descending priority: cfg-set-syncnorvt

Name cfg-set-syncnorvt

Function Enable/Disable switching in the sequence of descending priority.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-syncnorvt:Bid, Flag
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 9 or 10

2 Flag: disable or enable

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-syncnorvt:9,disable

Precautions

Remarks

1.7.25 Query the enabling status of switching the clock source in the sequence of descending
priority: cfg-get-syncnorvt

Name cfg-get-syncnorvt

Function Query the enabling status of switching the clock source in the sequence of descending priority.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-syncnorvt:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 138 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-syncnorvt:9
SYN-RVT-MODE : disable

Example :cfg-get-syncnorvt:9

Precautions

Remarks

1.7.26 Set the data output mode in the Keep mode: cfg-set-synkeepmode

Name cfg-set-synkeepmode

Function Set the data output mode in the Keep mode.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-synkeepmode:Bid, KeepMode
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
KeepMode: Data output mode
2 Value and meaning: 0 for normal data output mode; 1 for
keeping the final data.

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-synkeepmode:9,1

Precautions

Remarks

1.7.27 Query the data output mode in the Keep mode: cfg-get-synkeepmode

Name cfg-get-synkeepmode

Function Query the data output mode in the Keep mode.

Command Level System monitoring

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 139 of 243

:cfg-get-synkeepmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-synkeepmode:9
24HOUR-KEEP-MODE : 0

Example :cfg-get-synkeepmode:9

Precautions

Remarks

1.7.28 Set the working mode for the data output of the external source: cfg-set-outsynmode

Name cfg-set-outsynmode

Function To set the working mode for the data output of the external source.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-outsynmode:Bid, ExtSyn1Mode, ExtSyn2Mode

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
2 ExtSyn1Mode: bit£>2Mbit; hz£>2Mhz

3 ExtSyn2Mode: bit£>2Mbit; hz£>2Mhz

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-outsynmode:9,hz,hz

Precautions

Remarks

1.7.29 Query the working mode of the data output of the external source: cfg-get-outsynmode

Name cfg-get-outsynmode

Function To query the working mode of the data output of the external source.

Command Level System monitoring

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 140 of 243

Available to User level

Version 5.21.01

:cfg-get-outsynmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-outsynmode:9
Output Format EXTSYN-OUT-MODE
EXT1-MODE EXT2-MODE
bit bit
Total records :1

Example :cfg-get-outsynmode:9

Precautions

Remarks

1.7.30 Set the data output threshold for the external source: cfg-set-outputth

Name cfg-set-outputth

To set the data output threshold for the external source.

Function
Cut the clock output when the local clock quality is lower than this threshold.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-outputth:Bid, SynId, ThValue

Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

2 SynId: 0xf001 or 0xf002

ThValue: Output threshold

Input Parameters
Value Meaning
0 £> Threshold not activated (QL_DNU)
1 £> Not lower than the SETS clock (QL_SEC)
3
2 £> Not lower than the G.812 clock of the local exchange
(QL_SSUB)
3 £> Not lower than the G.812 clock of the transit exchange
(QL_SSUA)
4 £> Not lower than the G.811 clock (QL_PRC)

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 141 of 243

Example :cfg-set-outputth:9,0xf001,2

Precautions

Remarks

1.7.31 Query the data output threshold of the external source: cfg-get-outputth

Name cfg-get-outputth

Function To query the data output threshold of the external source.

Command Level System monitoring

Available to Customer service level

Version 5.21.01

:cfg-get-outputth:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 9 or 10

2 SynId: 0xf001 or 0xf002

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-outputth:9,0xf001
Output Format EXT-OUTPUT-TH
EXT-SYN EXT-OUT-TH
0xf001 0
Total records :1

Example :cfg-get-outputth:9,0xf001

Precautions

Remarks

1.7.32 Set maunually the S1 byte clock quality: cfg-set-mans1qua

Name cfg-set-mans1qua

Function To set manually the S1 byte clock quality.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-mans1qua:Bid, SynId, S1Quality

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 142 of 243

1 Bid: 9 or 10

2 SynId: Clock source ID

S1Quality: S1 byte clock quality

Input Parameters Value Meaning

0x00 Synchronous quality unknown
0x02 Signal of the G.811 clock
3
0x04 Signal of the G.812 transit exchange clock
0x08 Signal of the G.812 local exchange clock
0x0b Signal of the synchronous device timing source
0x0f Not used for synchronization
0xFF Manual configuration cancelled

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-mans1qua:9,0x0501,0x02

Precautions The clock source should be that recorded in the priority list; the internal source should not be set to unusable.

Remarks

1.7.33 Query the S1 byte clock quality: cfg-get-mans1qua

Name cfg-get-mans1qua

Function To query the S1 byte clock quality.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-mans1qua:Bid, SynId
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
SynId: Clock source ID
2
0 means to query all the clock sources for which the S1 byte is
configured manually in the priority list.

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-mans1qua:9,0
Output Format MAN-S1-QUALITY
SYN-SOURCE S1-QUALITY
0x0701 0x02
Total records :1

Example :cfg-get-mans1qua:9,0x0401

The clock source should be that recorded in the priority list. If no manually-configured S1 byte is available,
Precautions
NSERR_CFG_GET_NULL will be returned.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 143 of 243

Remarks

1.7.34 Set the waiting time for the clock source recovery: cfg-set-synwtrtime

Name cfg-set-synwtrtime

Function To set the waiting time for the clock source recovery.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-synwtrtime:Bid, WtrTime
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
WtrTime: Wait time for recovery
2 Value and unit: 0-12 minutes
Default: 5 minutes

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-synwtrtime:9,5

Precautions

Remarks

1.7.35 Query the waiting time for the clock source recovery: cfg-get-synwtrtime

Name cfg-get-synwtrtime

Function To query the waiting time for the clock source recovery.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synwtrtime:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-synwtrtime:9
SYN-WTR-TIME : 5

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 144 of 243

Example :cfg-get-synwtrtime:9

Precautions

Remarks

1.7.36 Set ID for the S1 byte clock source: cfg-set-syns1id

Name cfg-set-syns1id

Function To set ID for the S1 byte clock source.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-syns1id:Bid, SynSubNetId, SynId, NodeId

Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

2 SynSubNetId: Subnet ID of the clock source

Input Parameters
3 SynId: Clock source ID

NodeId: ID of the S1 byte; value range: 0x00-0x0f; 0 means no

4
ID configuration.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-syns1id:9,1,0x0401,0x01

Precautions The clock source should be that recorded in the priority list.

Remarks

1.7.37 Query the ID of the S1 byte clock source: cfg-get-syns1id

Name cfg-get-syns1id

Function To query the ID of the S1 byte clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-syns1id:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 145 of 243

Input Parameters 1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-syns1id:9
SYN-NODE-ID
Output Format
SYN-SUBNET SYN-SOURCE NODE-ID
1 0x0701 0x01
1 0xf101 0000
Total records :2

Example :cfg-get-syns1id:9

Precautions If the ID of each clock source is 0x00, NSERR_CFG_GET_NULL will be returned for no result.

Remarks

1.7.38 Set the input mode for the external source: cfg-set-insynmode

Name cfg-set-insynmode

Function To set the input mode for the external source.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-insynmode:Bid, ExtSyn1Mode, ExtSyn2Mode

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

ExtSyn1Mode: Input mode of the first external source

Input Parameters 2 Value and meaning: bit£>2Mbit
hz£>2Mhz

ExtSyn2Mode: Input mode of the second external source

3 Value and meaning: bit£>2Mbit
hz£>2Mhz

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-insynmode:9,bit,bit

Precautions

Remarks

1.7.39 Query the input mode of the external source: cfg-get-insynmode

Name cfg-get-insynmode

Function To query the input mode of the external source.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 146 of 243

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-insynmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-insynmode:9
Output Format EXTSYN-IN-MODE
EXT1-MODE EXT2-MODE
bit bit
Total records :1

Example :cfg-get-insynmode:9

Precautions

Remarks

1.7.40 Set the SSM protocol mode for the S1 byte: cfg-set-s1mode

Name cfg-set-s1mode

Function To set the SSM protocol mode for the S1 byte.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-s1mode:Bid, S1Mode
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
S1Mode: S1 byte protocol mode
disables1: SSM protocol not activated
2
expands1: Expanded SSM protocol mode
standards1: Standard SSM protocol mode

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-s1mode:9, standards1

Precautions

Remarks SSM: Synchronization Status Message

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 147 of 243

1.7.41 Query the SSM protocol mode of the S1 byte: cfg-get-s1mode

Name cfg-get-s1mode

Function To query the SSM protocol mode of the S1 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-s1mode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-s1mode:9
S1-MODE : disables1

Example :cfg-get-s1mode:9

Precautions

Remarks

1.7.42 Permit/Forbid the optical interface corresponding to the clock source to output the S1
byte: cfg-set-s1exportmode

Name cfg-set-s1exportmode

Function Enable/Disable the optical interface corresponding to the clock source to output the S1 byte.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-s1exportmode:Bid, SynId, Flag

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
2 SynId: Line source ID

3 Flag: permit or forbid

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 148 of 243

Example :cfg-set-s1exportmode:9,0x0401,permit

Precautions

Remarks

1.7.43 Query the status of permitting/forbidding the optical interface corresponding to the clock
source to output the S1 byte: cfg-get-s1exportmode

Name cfg-get-s1exportmode

To query the status of permitting/forbidding the optical interface corresponding to the clock source to output the
Function
S1 byte.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-s1exportmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-s1exportmode:9
Output Format S1-EXPORT-MODE
SYN-SOURCE ENABLE-FLAG
0x0701 forbid
Total records :1

Example :cfg-get-s1exportmode:9

If the line source or external source with configured S1 byte output is not available, NSERR_CFG_GET_NULL
Precautions
will be returned.

Remarks

1.7.44 Query the current working mode of the clock board: cfg-get-stgworkmode

Name cfg-get-stgworkmode

Function To query the current working mode of the clock board (tracing/keeping/free mode).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-stgworkmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 149 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Output Format Return the ¡°Suceeded!¡± or ¡°Failed!¡± message.

Example :cfg-get-stgworkmode:9

Precautions

Remarks

1.7.45 Set the quality level represented by QL_UNKNOW: cfg-set-qlunknow

Name cfg-set-qlunknow

Function To set the quality level represented by QL_UNKNOW.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-qlunknow:Bid, QlUnknow, QlUnknow

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

Input Parameters QlUnknow: Quality level of the clock source

2
QL_PRC,QL_SSUA,QL_SSUB,QL_SEC,QL_DNU

QlUnknow: Quality level of the clock source

3
QL_PRC,QL_SSUA,QL_SSUB,QL_SEC,QL_DNU

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-qlunknow:9, QL_PRC, QL_SSUA

¡¡The value of the clock source quality must be in the upper case and consecutive. Set two reference levels, and define the
Precautions QL_UNKNOW level between these two reference levels. When these two reference levels are the same, define the
L_UNKNOW level equal to this level; when they are consecutive, define the QL_UNK level between these two levels.

Remarks

1.7.46 Query the quality level represented by QL_UNKNOW: cfg-get-qlunknow

Name cfg-get-qlunknow

Function To query the quality level represented by QL_UNKNOW.

Command Level System monitoring

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 150 of 243

Version 5.21.01

:cfg-get-qlunknow:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-qlunknow:9
QL-UNKNOW
Output Format
QLUNKNOW-VALUE QLUNKNOW-VALUE
QL_DNU QL_DNU
Total records :1

Example :cfg-get-qlunknow:9

Precautions

Remarks

1.7.47 Permit/Forbid the optical interface to output the clock ID: cfg-set-s1idexportmode

Name cfg-set-s1idexportmode

Function Permit/Forbid the optical interface to output the clock ID.

Command Level System maintenance

Available to Customer service level

Version 5.21.01

:cfg-set-s1idexportmode:Bid, SynId, Flag

Input Format
Number of parameters: 3; repetitive parameter blocks.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
2 SynId: Line source ID

3 Flag: permit or forbid

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-s1idexportmode:9,0x0401,permit

Precautions The clock source can be the line source only.

Remarks

1.7.48 Query the status of permitting/forbidding the optical interface to output the clock ID: cfg-
get-s1idexportmode

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 151 of 243

Name cfg-get-s1idexportmode

Function Query the status of permitting/forbidding the optical interface to output the clock ID.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-s1idexportmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Output Format

Example :cfg-get-s1idexportmode:9

Precautions If the line source with configured clock ID output is not available, NSERR_CFG_GET_NULL will be returned.

Remarks

1.7.49 Enable/Disable the frequency deviation function of the clock source: cfg-set-synbaddetect

Name cfg-set-synbsynaddetect

Function Enable/Disable the frequency deviation function of the clock source.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-synbaddetect:Bid, Flag
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 9 or 10

2 Flag: disable or enable

Output Format

Example :cfg-set-synbaddetect:9,enable

Precautions

Remarks

1.7.50 Query the status (enable/disable) of the frequency deviation function of the clock source:
cfg-get-synbaddetect

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 152 of 243

Name cfg-get-synbaddetect

Function Query the status (enable/disable) of the frequency deviation function of the clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synbaddetect:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 9 or 10

Output Format

Example :cfg-get-synbaddetect:9

Precautions

Remarks

1.7.51 Set the condition for the external source failure: cfg-set-lapseterm

Name cfg-set-lapseterm

Function Set the condition for the external source failure.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-lapseterm:Bid,SynId,LapseTerm,Flag
Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10

Input Parameters 2 SynId: 0xf001 or 0xf002

3 LapseTerm: AIS or LOF

4 Flag: disable or enable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-lapseterm:9,0xf001,AIS,enable

Precautions

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 153 of 243

1.7.52 Query the condition for the external source failure: cfg-get-lapseterm

Name cfg-get-lapseterm

Function Query the condition for the external source failure.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lapseterm:Bid
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
2 SynId: 0xf001 or 0xf002

3 LapseTerm: AIS or LOF

Output Format

Example :cfg-get-lapseterm:9,0xf001,AIS

Precautions

Remarks

1.7.53 Query the working status and DA value of the current clock source: cfg-get-synstatusda

Name cfg-get-synstatusda

Function To query the working status and DA value of the current clock source.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-synstatusda:Bid, PllType
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 9 or 10
Input Parameters
PllType: PLL type
2 0: 38M digital PLL
1: 155M digital PLL

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-synstatusda:9,0

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 154 of 243

SYN-STATUS-DA
PLLTYPE STATUS DA
0 2 2047
PLLTYPE: Phase souce type
Output Format STATUS: Locking status
0: Tracing suceeded
1: Tracing failed
2: Others (keeping or free mode)
DA: DA value of the phase source

Example :cfg-get-synstatusda:9, 0

Precautions

Remarks PLL: Phase-Locked Loop

1.8 EOW Configuration Commands

1.8.1 Set the orderwire number: cfg-set-telnum

Name cfg-set-telnum

Function To set the orderwire number; support the one route addressing call only.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-telnum:Bid,TelNo,TelNum
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
2 TelNo: Telephone sequence No., only support 1;

TelNum: 100~99999999; should meet the number length

3
requirement.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-telnum:37,1,101

The first figure of the number should not be 0, which is invalid as the first figure. Set the number length before
Precautions setting the orderwire number; otherwise, you can only set a number with three figures (the default length). If you
set an overlong number, the host will return a length error message. The initial number is 0x101 before setting.

Remarks

1.8.2 Query the orderwire number: cfg-get-telnum

Name cfg-get-telnum

Function To query the orderwire number.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 155 of 243

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-telnum:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-telnum:37
Output Format TELE-NUMBER
TEL-No TELE-NUMBER
1 101
Total records :1

Example :cfg-get-telnum:37

Precautions

Remarks

1.8.3 Set the conference orderwire number for the whole network: cfg-set-meetnum

Name cfg-set-meetnum

Function To set the conference orderwire number for the whole network.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-meetnum:Bid,MeetNum
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
MeetNum: 100~99999999, 999 by default; should meet the
2 length requirements for telephone numbers. Besides, set
0XFFFFFFFF to reset the local telephone number.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-meetnum:37,999

Precautions

Remarks

1.8.4 Query the conference orderwire number of the whole network: cfg-get-meetnum

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 156 of 243

Name cfg-get-meetnum

Function To query the conference orderwire number of the whole network.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-meetnum:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-meetnum:37
MEETING-NUMBER : 999

Example :cfg-get-meetnum:37

Precautions

Remarks ¡¡

1.8.5 Set the telephone number length: cfg-set-tellen

Name cfg-set-tellen

Function To set the telephone number length.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tellen:Bid, TelLen
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
TelLen: Length of the telephone number; value range 3~8;
2
adopt 3 by default.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-tellen:37,3

After changing the length of the telephone number, it is necessary to reset the orderwire number and the
Precautions whole network conference call number. For the network elements sharing the same orderwire, the length of
the orderwire number should be the same.

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 157 of 243

1.8.6 Query the telephone number length: cfg-get-tellen

Name cfg-get-tellen

Function To query the length of the telephone number.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tellen:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter
Parameter meaning and value
location
Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format :cfg-get-tellen:37
TELE-NUMBER-LEN: 3

Example :cfg-get-tellen:37

Precautions

Remarks

1.8.7 Set the call waiting time: cfg-set-reqtime

Name cfg-set-reqtime

Function To set the call waiting time.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-reqtime:Bid, ReqTime
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 37

2 ReqTime: Call waiting time, 1-9 seconds; 9 by default.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-reqtime:37,5

Precautions ¡¡

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 158 of 243

1.8.8 Query the call waiting time: cfg-get-reqtime

Name cfg-get-reqtime

Function To query the call waiting time.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-reqtime:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format :cfg-get-reqtime:37
REQ-TIME : 9

Example :cfg-get-reqtime:37

Precautions

Remarks

1.8.9 Set the availability of the optical interface in the addressing call: cfg-set-lineused

Name cfg-set-lineused

Function To set the availability of the optical interface in the addressing call.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lineused:Bid, DstBid, PortId, LineUsed

Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

Input Parameters 2 DstBid: 1~8,11~16(40G)/17(80G)

3 PortId: Optical interface ID

4 LineUsed: used, unused

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-lineused:37,2,2,used

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 159 of 243

Precautions

Remarks

1.8.10 Query the availability of the optical interface in the addressing call: cfg-get-lineused

Name cfg-get-lineused

Function To query the availability of the optical interface in the addressing call.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lineused:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
:cfg-get-lineused:37
TELE-LINE-USED
EowBid IuBid PortId LineUsed
37 7 1 unused
37 7 2 unused
37 7 3 unused
37 7 4 unused
Output Format 37 12 1 unused
37 12 2 unused
37 12 3 unused
37 12 4 unused
37 13 1 unused
37 13 2 unused
37 13 3 unused
37 13 4 unused
Total records :12

Example :cfg-get-lineused:37

Precautions ¡¡

Remarks

1.8.11 Set the availability of the optical interface in the conference call: cfg-set-meetlineused

Name cfg-set-meetlineused

Function To set the availability of the optical interface in the conference call.

Command Level System operation

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 160 of 243

:cfg-set-meetlineused:Bid, DstBid, PortId, LineUsed

Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

Input Parameters 2 DstBid: 1~8,11~16(40G)/17(80G)

3 PortId: Optical interface ID

4 LineUsed: used, unused

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-meetlineused:37,1,16,used

Precautions

Remarks

1.8.12 Query the availability of the optical interface in the conference call: cfg-get-meetlineused

Name cfg-get-meetlineused

Function To query the availability of the optical interface in the conference call.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-meetlineused:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
:cfg-get-meetlineused:37
MEETING-LINE-USED
EowBid IuBid PortId LineUsed
37 7 1 unused
37 7 2 unused
37 7 3 unused
37 7 4 unused
Output Format 37 12 1 unused
37 12 2 unused
37 12 3 unused
37 12 4 unused
37 13 1 unused
37 13 2 unused
37 13 3 unused
37 13 4 unused
Total records :12

Example :cfg-get-meetlineused:37

Precautions ¡¡

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 161 of 243

Remarks

1.8.13 Set the TS and broadcast source of the broadcast data port: cfg-set-dataport

Name cfg-set-dataport

Function To set the TS and broadcast source of the broadcast data port.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-dataport:Bid, Slot, Src, DstNum, Dst,Dst,Dst.....

Input Format
Number of parameters not specified; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

2 Slot: Overhead bytes S1-S4; value 1-4.

Src: Master interface No.; double-byte hexadecimal number. For

the opetical interface, the high byte stands for the board ID, and
3
the low byte for the optical interface number. The number of the
Input Parameters four data interface is respectively 0xff01~0xff04.

4 DstNum: Number of the slave interface

Number of No.1 slave interface: The numbering rules are the

5
same as those of the master interface number.

£®£®£® ¡¡

N+4 Number of No.N slave interface:

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-dataport:37,1,0x0401,2,0x0501,0x0601

The board number and optical interface number reflected by the master and each slave interface should exist and
be consistent with those of the actually installed devices. The number of the optical interface should not be higher
than 8.
Precautions
The number of the internal slave interfaces of each overhead byte should be different from each other; the
number of the master and slave interfaces should also be different.
The data interface number should be consistent with the overhead byte number.

Remarks

1.8.14 Delete the configuration information of the broadcast data interface: cfg-del-dataport

Name cfg-del-dataport

Function To delete the configuration information of the broadcast data interface.

Command Level System operation

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 162 of 243

Version 5.21.01

:cfg-del-dataport:Bid, OhSlot
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 37

2 OhSlot: Overhead byte S1-S4; value is 1~4.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-del-dataport:37,1

Precautions ¡¡

Remarks

1.8.15 Query the TS and source of the broadcast data interface: cfg-get-dataport

Name cfg-get-dataport

Function To query the configuration information of the broadcast data interface at the designated timeslot.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-dataport:Bid, OhSlot
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
OhSlot: Overhead byte S1-S4; value is 1~4.
2
0 means to query all the overhead bytes.

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-dataport:37,1
DATA-PORT : 1 0xff01 2 0x0701 0x0c01

Example :cfg-get-dataport:37,1

Precautions ¡¡

Remarks

1.8.16 Set the multiplex port to the com port or the broadcast data port: cfg-set-porttype

Name cfg-set-porttype

Function Set the multiplex port to the com or broadcast data port.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 163 of 243

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-porttype:Bid, Port1, Port2

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
2 Port1: data or com

3 Port2: data or com

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-porttype:37,com,data

Precautions

The multiplex port 1 is corresponding to the com port 1 or the data port 1; the multiplex port 2 is corresponding
Remarks
to the com port 2 or the data port 2.

1.8.17 Query the port type of the multiplex port: cfg-get-porttype

Name cfg-get-porttype

Function To query the port type of the multiplex port.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-porttype:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-porttype:37
Output Format PORT-MULTI-TYPE
COM1 COM2
data data
Total records :1

Example :cfg-get-porttype:37

Precautions ¡¡

Remarks

1.8.18 Set the electrical characteristics of the port: cfg-set-portmode

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 164 of 243

Name Cfg-set-portmode

Function Set the electrical characteristics of the port.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-portmode:Bid, PortName, Mode

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
2 PortName: com1, com2, data1, data2, data3 or data4

3 Mode: rs232 or rs422

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-portmode:37,data2,rs232

Precautions

Remarks

1.8.19 Query the electrical characteristics of the port: cfg-get-portmode

Name cfg-get-portmode

Function Query the electrical characteristics of the port.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-portmode:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-portmode:37
DATA-PORT-WORKMODE
EOW-Bid Port WorkMode
37 data1 rs232
Output Format
37 data2 rs422
37 data3 rs232
37 data4 rs232
37 com1 rs232
37 com2 rs232
Total records :6

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 165 of 243

Example :cfg-get-portmode:37

Precautions ¡¡

Remarks

1.8.20 Set the F1 data port: cfg-set-f1port

Name cfg-set-f1port

Function To set the F1 data port.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-f1port:Bid,F1id,InputPort,OutputPort
Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

2 F1ID: 1~60
Input Parameters
InputPort: Number of the uplink port; see Precautions for the
3
value.

OutputPort: Number of the downlink port; see Precautions for the

4
value.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-f1port:37,1,0xff00,0x0101

Rules for setting the port number:

1. For the optical port, the high byte stands for the line board ID, and the low byte for the number of the optical
port.
Precautions 2. The line board corresponding to the optical port must have been installed, and the number of the optical port
should not be higher than the max optical port number of the corresponding line board.
3. Use 0xFF00 to represent the F1 port.
4. If both the uplink and downlink ports are 0, it means to cancel the F1 pass-through configuration.

Remarks

1.8.21 Query the configuration of F1 data port: cfg-get-f1port

Name cfg-get-f1port

Function To query the pass-through configuration of the F1 data port.

Command Level System monitoring

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 166 of 243

:cfg-get-f1port:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-f1port:37
Output Format F1-PASSTHROUGH
F1_ID INPUT_PORT OUTPUT_PORT
1 0xff00 0x0701
Total records :1

Example :cfg-get-f1port:37

Precautions ¡¡

Remarks

1.8.22 Delete the pass-through configuration of the F1 data port (See the ¡°Set the F1 data port¡±
command)

1.8.23 Set the subnet number length: cfg-set-subnetlen

Name cfg-set-subnetlen

Function To set the length of the subnet number.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-subnetlen: Bid, SubnetLen

Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid:37

2 SubnetLen: 1~2

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-subnetlen: 37,1

When the length of the subnet number changes, the system will automatically clear all the configured subnet
Precautions number served by the optical ports, in case that the length of the subnet number conflicts with the subnet
number served by the optical ports. All the subnet number corresponding to the optical ports are reset to 0.

Remarks

1.8.24 Query the subnet number length: cfg-get-subnetlen

Name cfg-get-subnetlen

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 167 of 243

Function To query the subnet number length

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-subnetlen:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-subnetlen:37
SUBNET-LEN : 1

Example :cfg-get-subnetlen:37

Precautions ¡¡

Remarks

1.8.25 Set the subnet number: cfg-set-subnetbd

Name cfg-set-subnetbd

Function To set the subnet number served by the optical ports.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-subnetbd:Bid, IuBid, Pid, SubnetId

Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

Input Parameters 2 IuBid: 1~8,11~16(40G)/17(80G)

3 Pid: Optic port ID

4 SubnetId: See Precautions for the value.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-subnetbd: 37,5&6,1,0x01

0 (default) means that this optical port does not belong to any subnet. When the subnet number is not 0, the
value should be consistent with the configured subnet number length. When the subnet number length is 1, the
Precautions
value of the number should be one from 1~9; when the length is 2, the subnet number should be one from
10~99. The subnet number should be composed of figures 0~9.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 168 of 243

Remarks

1.8.26 Query the subnet number: cfg-get-subnetbd

Name cfg-get-subnetbd

Function To query the subnet number served by the optical port.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-subnetbd:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid:37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:

:cfg-get-subnetbd:37
PORT-SUBNET-ID
Output Format
Bid PortId SUBNET-ID
7 1 0x01
12 1 0x01
Total records :2

Example :cfg-get-subnetbd:37

Precautions ¡¡

Remarks

1.8.27 Set the status (enable/disable) of the auto switch protection: cfg-set-autoswitch

Name cfg-set-autoswitch

Function To set the status (enable/disable) of the auto switch protection.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-autoswitch:Bid, Flag
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 37

2 Flag: disable or enable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 169 of 243

Example :cfg-set-autoswitch:37,enable

Precautions

Remarks

1.8.28 Query the status (enable/disable) of the auto switch protection: cfg-get-autoswitch

Name cfg-get-autoswitch

Function To query the status (enable/disable) of the auto switch protection.

Command Level System monitoring

Available to User level

Version 5.21.01

cfg-get-autoswitch:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Bid: 37

Return the ¡°Failed!¡± message upon failure; return the following in the text format upon success:
Output Format
:cfg-get-autoswitch:37
AUTO-SWITCH : enable

Example :cfg-get-autoswitch:37

Precautions

Remarks

1.8.29 Test the telephone ring: cfg-set-ringtest

Name cfg-set-ringtest

Function To test the telephone ring.

Command Level System debugging

Available to User level

Version 5.21.01

:cfg-eow-ringtest:Bid, TelNo, Flag

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
2 TelNo: 0

3 Flag: 1 for ringing; 0 for stopping ringing.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 170 of 243

Output Format

Example :cfg-eow-ringtest:37,0,1

¡¡This command is used to activate or deactivate the ringing. The returned error shows only wehter the
Precautions software succeeded in setting the hardware. Users have to judge by themselves whether the ringing is
activated or not.

Remarks

1.8.30 Test the ring back tone: cfg-set-alerttest

Name cfg-eow-alerttest

Function Test the ring back tone.

Command Level System debugging

Available to User level

Version 5.21.01

:cfg-eow-alerttest:Bid, TelNo, Flag

Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
TelNo: Data port number, 0~2; only 0 can be used in OSN
2
3500/OSN 2500.

3 Flag: 1 for ringing; 0 for stopping ringing.

Output Format

Example :cfg-eow-alerttest:37,0,1

This command is used to activate or deactivate the ring back tone. The returned error shows only whether the
Precautions software succeeded in setting the hardware. Users have to judge by themselves whether the the ring back
tone is activated and whether it is correct.

Remarks

1.8.31 Test the call dialing: cfg-set-dialnumtest

Name cfg-eow-dialnumtest

Function To test the call dialing.

Command Level System debugging

Available to User level

Version 5.21.01

:cfg-eow-dialnumtest:Bid, TelNo
Input Format
Number of parameters: 2; parameters not repetitive.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 171 of 243

Parameter location Parameter meaning and value

1 Bid: 37
Input Parameters
TelNo: Data port number, 0~2; only 0 can be used in OSN
2
3500/OSN 2500.

Output Format

Example :cfg-eow-dialnumtest:37,0

The user dials a number randomly before using this testing interface. The return parameter para[2]~para[5]
Precautions returns the telephone number dialed by the user just now. The default destination number is 0xffffffff; it is an
invalid telephone number.

Remarks Load the testing commands.

1.9 Commands for Configuring Optical amplifier board Properties

1.9.1 Open/Close the pump laser: cfg-set-pumplasersw

Name cfg-set-pumplasersw

Function To open/close the pump laser.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-pumplasersw:Bid,Pid,PathId,LaserSts
Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

Input Parameters 2 Pid: 1~2

3 PathId: 1

4 LaserSts: open or close

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-pumplasersw:2,1,1,close

Precautions This command is delivered directly to the board. Therefore, the optical amplifier board must be online.

Remarks

1.9.2 Query the status (open/close) of the pump laser: cfg-get-pumplasersw

Name cfg-get-pumplasersw

Function To query the status (open/close) of the pump laser.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 172 of 243

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-pumplasersw:Bid,Pid,PathId
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS) (same as the

1
line board ID)
Input Parameters
2 Pid: 1~2 (for the optical amplifier board)

PathId: 1 (At present, the optical amplifier board in the SDH

3 devices has only one pump laser, which is generally defaulted
as 1.)

Output Format

Example :cfg-get-pumplasersw:2,1,1

Precautions This command is delivered directly to the board. Therefore, the optical amplifier board must be in position.

Remarks

1.9.3 Query the type of the optical amplifier board: cfg-get-oatype

Name cfg-get-oatype

Function To query the type of the optical amplifier board.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-oatype:Bid
Input Format
Number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS) (same as the
1
line board ID)

:cfg-get-oatype:11
OATYPE
Output Format Bid OATYPE
11 BA2
Total records :1

Example :cfg-get-oatype:2

Precautions This command is delivered directly to the board. Therefore, the optical amplifier board must be in position.

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 173 of 243

1.9.4 Query the performance parameter list of the optical amplifier board: cfg-get-paralist

Name cfg-get-paralist

Function To query the performance parameter list of the optical amplifier board.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-paralist:Bid,Pid
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS) (same as the

Input Parameters 1
line board ID)

2 Pid: 1~2 (number of the optical port)

:cfg-get-paralist:11,1
OAPARALIST
Output Format Bid Pid LSRNUM INPWRCUR OUTPWRCUR LSRNO RWC MCC WC CC PC LSRTEMP
11 1 1 280 146 0 250 2000 0 18 0 250
Total records :1

Example :cfg-get-paralist:2

Precautions This command is delivered directly to the board. Therefore, the optical amplifier board must be in position.

Remarks

1.10 Alarm Bolean Management

1.10.1 Set the output status of the alarm relay switch: cfg-set-cskswitch

Name cfg-set-cskswitch

Function Set the output status of the alarm relay switch.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-cskswitch:Bid,CtrlMode,Relay0Flag,Relay1Flag
Input Format
Number of parameters: 4; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 37

CtrlMode: pmuauto, pmumanual

2
Default: pmuauto

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 174 of 243

The status of the common alarm relay includes open and close: open means to
3 open the path (to close the Bolean); close means to close the path (to shut down
the Bolean output). The default status is close.
Input Parameters
The status of the servere alarm relay includes also open and close: open means
4 to open the path (to close the Bolean); close means to close the path (to shut
down the Bolean output). The default status is close.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-cskswitch:18,pmumanual,open,open

Precautions The configuration delivered by this command is invalid in the auto control mode.

Remarks

1.10.2 Query the output status of the alarm relay switch: cfg-get-cskswitch

Name cfg-get-cskswitch

Function To query the output status of the alarm relay switch.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-cskswitch:Bid
Input Format
Defining the location; number of parameters: 1; parameters not repetitive.

Parameter location Parameter meaning and value

Input Parameters
1 Slot ID

Return the error message on failure; return the following in the table
format on success:
CSK-SWITCH
Output Format
CONTROL-MODEK 0-STATUSK 1-STATUS
<Relay control mode > <Status of the common alarm relay ><Status of
the servere alarm relay >

Example :cfg-get-cskswitch:18

open means to open the path (to close the Bolean); close means to close
Precautions
the path (to shut down the Bolean output).

Remarks

1.10.3 Set the output status of the auxiliary function relay: cfg-set-extrelayuse

Name cfg-set-extrelayuse

Function Set the output status of the auxiliary function relay.

Command Level System operation

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 175 of 243

Version 5.21.01

:cfg-set-extrelayuse:Bid,ExtRelayNo,ExtRelayUsed
Input Format Define the location; number of parameters: 3; the second parameter
repeated.

Parameter location Parameter meaning and value

1 Slot ID
Input Parameters
2 Number of the configured auxiliary function relay

3 Status of the configured auxiliary function relay: open and close

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-extrelayuse:18,1,close

Precautions

Remarks

1.10.4 Query the output status of the auxiliary function relay: cfg-get-extrelayuse

Name cfg-get-extrelayuse

Function To query the output status of the auxiliary function relay.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-extrelayuse:Bid,ExtRelayNo
Input Format Define the location; number of parameters: 2; the second parameter
repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Slot ID

2 Number of the configured auxiliary function relay

Return the error message on failure; return the following in the table format
on success:
EXT-RELAY-USE
Output Format
ExtRelayNo ExtRelayStatus
<Number of the auxiliary function relay output ><Status of the auxiliary
function relay output >

Example :cfg-get-cskswitch:18,1

Precautions

Remarks

1.10.5 Set the relay input mode: cfg-set-onerelayuse

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 176 of 243

Name cfg-set-onerelayuse

Function Set the relay input mode.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-onerelayuse:Bid,RelayNo,UseStatus,AlmSwitch
Input Format Define the location; number of parameters: 4; the second parameter
repeated.

Parameter location Parameter meaning and value

1 Slot ID

2 Number of the configured auxiliary function relay

Input Parameters
3 The relay status includes enable and disable; the default status is disable.

The status of the alarm switch includes open and close: open refers to the
4 alarm when the relay is on; close refers to the alarm when the relay is off.
The default status is close.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-onerelayuse:14,1&&8,enable,open

Precautions

Remarks

1.10.6 Query the relay input mode: cfg-get-onerelayuse

Name cfg-get-onerelayuse

Function Query the relay input mode.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-onerelayuse:Bid,ExtRelayNo
Input Format Define the location; number of parameters: 2; the second parameter
repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Slot ID

2 Number of the queried auxiliary function relay

Return the error message on failure; return the following in the table
Output Format format on success:

INPUT-RELAY-USE

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 177 of 243

Bid InputRelayNo InputRelayStatus InputRelayAlm

<Bid> <Number of the input relay > <Relay working status > <Alarm
switch status>

Example :cfg-get-onerelayuse:18,1

Precautions

Remarks

1.11 Pluggable Laser Module Management

1.11.1 Query the laser module status: cfg-get-lsr-stat

Name cfg-get-lsr-stat

Function To query the laser module status (in position or not).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lsr-stat:Bid,Pid
Input Format
Number of parameters: 2; the second parameter repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the following in the table format upon success:

:cfg-get-lsr-stat:8,1
LSR-ONBOARD-STATUS
Output Format
BID Pid OnBoard Status
8 1 1
Total records :1
Status: 1 (for in position) and 0 (for not in position)

Example :cfg-get-lsr-stat:8,1

Precautions

Remarks

1.11.2 Query the laser module sequence number: cfg-get-lsr-sn

Name cfg-get-lsr-sn

Function To query the laser module sequence number.

Command Level System monitoring

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 178 of 243

Version 5.21.01

:cfg-get-lsr-sn:Bid,Pid
Input Format
Define the location; number of parameters: 2; the second parameter
repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the following in table format upon success:

:cfg-get-lsr-sn:7,1
Output Format LSR-SN
Bid Pid LSR-SN
7 1 45E487C00158
Total records :1

Example :cfg-get-lsr-sn:7,1

Precautions

Remarks

1.11.3 Query the laser module speed: cfg-get-lsr-speed

Name cfg-get-lsr-speed

Function To query the laser module speed.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lsr-speed:Bid,Pid
Input Format
Define the location; number of parameters: 2; the second parameter
repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the following in table format upon success:

:cfg-get-lsr-speed:8,1
LSR-SPEED
Output Format
BID Pid LSR Speed info(Mb/s)
8 1 622
Total records :1

Example :cfg-get-lsr-speed:8,1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 179 of 243

Precautions

Remarks

1.11.4 Query the laser module transmission distance: cfg-get-lsr-distance

Name cfg-get-lsr-distance

Function To query the laser module transmission distance.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lsr-distance:Bid,Pid
Input Format
Define the location; number of parameters: 2; the second parameter
repeated.

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the following in table format upon success:

:cfg-get-lsr-distance:8,1
Output Format LSR-DISTANCE
BID Pid LSR Distance info
8 1 15000
Total records :1

Example :cfg-get-lsr-distance:8,1

Precautions

Remarks

1.11.5 Query the laser module HWID: cfg-get-lsr-hwid

Name cfg-get-lsr-hwid

Function To query the laser module HWID (HuaWei Identity).

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lsr-hwid:Bid,Pid
Input Format
Define the location; number of parameters: 2; the second parameter
repeated.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 180 of 243

Parameter location Parameter meaning and value

Input Parameters 1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Return the following in table format upon success:

:cfg-get-lsr-hwid:8,1
LSR HWID
Output Format
Bid Pid LSR
HWID
8 0

Example
:cfg-get-lsr-hwid:8,1

Precautions

Remarks

1.11.6 Set the HWID for the pluggable laser module: cfg-set-lsr-hwid

Name cfg-set-lsr-hwid

Function To set the HWID (HuaWei Identity) for the pluggable laser module.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lsr-hwid:Bid,Pid,HWID
Input Format
Define the location; number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16(40G XCS),1-8, 11-17(80G XCS)

2 Pid: 1-X (Determine X according to the board type.)

Input Parameters HWID: Contain the following information (separated by **); the total
length not exceed 122 bytes.
1: HWID
2: The model of the laser
3
3: BOM code
4: Descriptions of BOM in chinese
5: Descriptions of BOM in english

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

:cfg-set-lsr-hwid:8, 1, " Huawei SBS ** SCP6861-H1-

Example BNE**34060282**¹âÊÕ·¢Ò»ÌåÄ£¿é-ESFP(ÄÚÍâÁ½ÖÖУ׼)-1550-
STM1-0dBm--5dBm--37dBm-LC-80km**abc**"

Precautions

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 181 of 243

Remarks

Chapter 2 Seveice and Protection

2.1 Report of Service and Protection Events
2.1.1 Report switchover events of the ring MS protection group

Name EVENT-MSSPR-SWITCH-EX

Function To report the switchover events of the ring MS protection group in the suppression mode.

Command Level System monitoring

Available to User level

Version 5.21.01

¡¡ EVENT-MSSPR-SWITCH-EX
PG-ID WEST-SWREQ WEST-SWSTA WEST-SWFLAG EAST-SWREQ EAST-SWSTA
1 SF_P S OFF NR I
Output Format
EAST-SWFLAG WEST-REQTYPE EAST-REQTYPE NODE-STATUS SQUELCH-STATUS
OFF LOCAL-REQ LOCAL-REQ NO-LONE NO-SQUELCH

2.1.2 Report the switchover events of the liner MS protection group

Name EVENT-LMS-SWITCH

Function To report the switchover events of the linear MS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

¡¡ EVT-LMS-SWITCH
Output Format PG-ID PU-ID SWITCH-REQUEST SWITCH-STATUS
1 1 LPS_SF S

2.1.3 Report the switchover events of the SNCP protection group

Name EVENT-SNCP-SWITCH

Function To report the switchover events of the SNCP protection group.

Command Level System debugging/System management/System maintenance/System operation/System monitoring

Available to User level

Version 5.21.01

Output Format ¡¡

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 182 of 243

Example ¡¡

Precautions ¡¡

Remarks ¡¡

2.1.4 Report the switchover events of the TPS protection group

Name EVENT-TPS-SWITCH

Function To report the switchover events of the TPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

EVENT-TPS-SWITCH
Output Format PG-ID SWITCHED-WORK-UNIT SWITCH-STATUS
1 1 tps-force

2.1.5 Report the status change events of the TPS protection board

Name EVENT-TPS-PROTECT-CHANGE

Function Report the status change events of the TPS protection board.

Command Level System monitoring

Available to User level

Version 5.21.01

¡¡ EVENT-TPS-PROTECT-CHANGE PG-ID PROTECT-BID-

Output Format STATUS
1 1

2.1.6 Report the switchover events of the DPS protection group

Name EVENT-CFG-DPS-SWITCH

Function To report the switchover events of the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

¡¡ EVENT-CFG-DPS-SWITCH
Output Format PG-ID MASTER-BD BACKUP-BD
1 9 10

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 183 of 243

2.2 Cross Connection Commands

2.2.1 Create the cross connection: cfg-add-xc

Name cfg-add-xc

Function To create the cross connection.

Command
System operation
Level

Available to User level

Version 5.21.01

:cfg-add-xc:xc-id,src-bid,src-pid,src-auid,src-pathid,dst-bid,dst-pid,dst-auid, dst-pathid,xc-level
Input Format
Number of parameters: 10; parameter blocks repeated.

Parameter
Parameter meaning and value
location

Cross connection sequence number:

1
0¡«3526: 0 refers to the auto distribution of the host software; 1~376(for high order services); 377~3526 (for low order services)

2 Source Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.)

3 Source Pid: 1-X (Determine X according to the board type installed on this board.)

Source high order PathId: Adopt 0 for this parameter when the board is a tributary board, while 1-X when the board is of other
4
types. Determine X according to the board type installed on this board.
Input
Source low order PathId: Adopt 0 for this parameter when the board is a tributary board or when XcLevel is high order; otherwise,
Parameters 5
adopt the corresponding low order PathId (VC12 or VC3).

6 Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.)

7 Destination Pid: 1-X (Determin X according to the board type installed on this board.)

Destination high order PathId: Adopt 0 for this parameter when the board is a tributary board, while 1-X when the board is of other
8
types. Determine X according to the board type installed on this board.

Destination low order PathId: Adopt 0 for this parameter when the board is a tributary board or when XcLevel is high order;
9
otherwise, adopt the corresponding low order PathId (VC12 or VC3).

10 Cross connection level: vc12, vc3, vc4, au4-4c, au4-8c, au4-16c, au4-64c, au3

Output Format ¡¡

:cfg-add-xc:0, 4, 1, 1, 0, 5, 1, 1, 0, vc4 (high order)

Example :cfg-add-xc:0, 4, 1, 1, 1, 11, 1, 0, 0, vc12 (low order)
:cfg-add-xc:0, 6, 1, 1, 1&&16, 3, 1&&16, 0, 0, vc12 (low order)

Precautions

Remarks

2.2.2 Delete the cross connection: cfg-del-xc

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 184 of 243

Name cfg-del-xc

Function Delete the cross connection.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-del-xc:src-bid,src-pid,src-auid,src-pathid,dst-bid,dst-pid,dst-auid,dst-pathid,xc-level
Input Format
Number of parameters: 9; parameter blocks repeated.

Parameter
Parameter meaning and value
location

1 Source Bid: 1-8£¬11-16£¬17 (Slot17 is supported only by 80G capacity.)

2 Source Pid: 1-X (Determine X according to the board type installed on this board.)

Source high order PathId: Adopt 0 for this parameter when the board is a tributary board, while 1-X when the board is of other
3
types. Determine X according to the board type installed on this board.

Source low order PathId: Adopt 0 for this parameter when the board is a tributary board or when XcLevel is high order; otherwise,
4
Input adopt the corresponding low order PathId (VC12 or VC3).
Parameters
5 Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.)

6 Destination Pid: 1-X (Determin X according to the board type installed on this board.)

Destination high order PathId: Adopt 0 for this parameter when the board is a tributary board, while 1-X when the board is of other
7
types. Determine X according to the board type installed on this board.

Destination low order PathId: Adopt 0 for this parameter when the board is a tributary board or when XcLevel is high order;
8
otherwise, adopt the corresponding low order PathId (VC12 or VC3).

9 Cross connection level: vc12, vc3, vc4, au4-4c, au4-8c, au4-16c, au4-64c, au3

Output Format ¡¡

Example :cfg-del-xc:6, 1, 1, 1&&63, 7, 1, 1, 1&&63, vc12

Precautions

Remarks

2.2.3 Query the cross connection: cfg-get-xc

Name cfg-get-xc

Function Query the cross connection.

Command
System monitoring
Level

Available to User level

Version 5.21.01

:cfg-get-xc:src-bid,dst-bid

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 185 of 243

Input Format Number of parameters: 2; parameters not repetitive.

Parameter
Parameter meaning and value
location
Input
Parameters 1 Source Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.); 0 refers to all the source boards.

2 Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.); 0 refers to all the destination boards.

Return the following relevant fields in the table format:

ID : ID
SRC-BD : Source board ID
SRC-PORT : Source port ID
SRC-AU : Source high order PathId
SRC-TU : Source low order PathId
Output Format
DST-BD : Destination board ID
DST-PORT : Destination port ID
DST-AU : Destination high order PathId
DST-TU : Destination low order PathId
LEVEL : Cross connection level
STATUS : Current status

:cfg-get-xc:0,0

CROSS-CONNECTION
Example
ID SRC-BD SRC-PORT SRC-AU SRC-TU DST-BD DST-PORT DST-AU DST-TU LEVEL STATUS
1 7 1 1 1 2 1 0 0 vc12 adding 2 5 1 1 0 6 1 1 0 vc4 adding 3 5 1 2 1 6 1
2 1 vc3 adding 4 5 1 3 1 6 1 3 1 vc12 adding Total records :4

Precautions ¡¡

Remarks ¡¡

2.2.4 Query the actual high order cross connection: cfg-get-xcconnect

Name cfg-get-xcconnect

Function To query the actual high order cross connection.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-xcconnect:src-bid,dst-bid
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Source Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the

1
cross capacity of 80G.); 0 refers to all the source boards.
Input Parameters
Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by
2 the cross capacity of 80G.); 0 refers to all the destination
boards.

Return the following relevant fields in the table format:

ID : Cross connection ID
SRC-BD : Source board ID
SRC-PORT : Source port ID

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 186 of 243

SRC-AU : Source high order PathId

SRC-TU : Source low order PathId (Return 0)
DST-BD : Destination board ID
DST-PORT : Destination port ID
Output Format
DST-AU : Destination high order PathId
DST-TU : Destination low order PathId (Return 0)
LEVEL : Cross connetion level
STATUS : Current status

:cfg-get-xcconnect:0,0
ACTUAL-CROSS-CONNECTION
ID SRC-BD SRC-PORT SRC-AU RSV DST-BD DST-PORT DST-AU RSV LEVEL BCSUM
1 13 1 4 0 11 1 4 0 vc4 2
2 13 1 5 0 11 1 5 0 vc4 2
3 13 1 6 0 11 1 6 0 vc4 2
4 13 1 7 0 11 1 7 0 vc4 2
Example 5 13 1 8 0 11 1 8 0 vc4 2
6 13 1 9 0 11 1 9 0 vc4 2
7 13 1 10 0 11 1 10 0 vc4 2
8 13 1 11 0 11 1 11 0 vc4 2
9 13 1 12 0 11 1 12 0 vc4 2
10 13 1 13 0 11 1 13 0 vc4 2
Total records :10

Precautions Query this command directly on the cross connection unit.

Remarks ¡¡

2.2.5 Query the high order cross connection route: cfg-get-connect

Name cfg-get-connect

Function Query the high order cross connetion route.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-connect:src-bid,dst-bid
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

Source Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of

1
Input Parameters 80G.); 0 refers to all the source boards.

Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity

2
of 80G.); 0 refers to all the destination boards.

Return the following relevant fields in the table format:

G1In G1 G1Out : Level-1 cross connection matrix
G2In G2 G2Out : Level-2 cross connection matrix
G3In G3 G3Out : Level-3 cross connection matrix
Output Format Src: Source index
CC : Concatenation service type
BC : Broadcast service type
GnIn and GnOut stands for the input and output VC4 granule of the Level-n cross connection matrix (n=1-3); G1, G2 and
G3 are the numbers of the cross connection modules.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 187 of 243

:cfg-get-connect:0,0
CLOS_CONNECTION
G1In G1 G1Out G2In G2 G2Out G3In G3 G3Out Src CC BC
0 0 0 0 0 152 0 0 0 0 1 1
Example
1 0 32 0 1 152 8 0 1 1 1 1
2 0 1 1 0 153 1 0 2 2 1 1
3 0 33 1 1 153 9 0 3 3 1 1
Total records :4

Precautions Query this command directly on the cross connection unit.

Remarks ¡¡

2.2.6 Cross connection query conditions: cfg-get-condxc

Name cfg-get-condxc

Function To provide conditions for querying the cross connection.

Command
System monitoring
Level

Available to User level

Version 5.21.01

:cfg-get-condxc:src-bid,src-pid,src-auid,dst-bid,dst-pid,dst-auid,xc-level
Input Format
Number of parameters: 7; parameters not repetitive.

Parameter
Parameter meaning and value
location

1 Source Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.); 0 refers to all the source boards.

2 Source Pid: 1-X (Determine X according to the board type installed on this board.); 0 refers to all the optical ports.

3 Source high order PathId: 1-X (Determine X according to the type of the optical port.); 0 refers to all the high order paths.
Input
Parameters
Destination Bid: 1-8£¬11-16£¬17 (Slot17 is only supported by the cross capacity of 80G.); 0 refers to all the destination
4
boards.

5 Destination Pid: 1-X (Determin X according to the board type installed on this board.); 0 refers to all the optical ports.

6 Destination PathId: 1-X (Determine X according to the type of the optical port.); 0 refers to all the high order paths.

7 Value of XcLevel: vc4,vc4c,vc8c,vc16c,vc64c,vc12,vc3,au3,all-level

ID : Cross connection ID
SRC-BD : Source Bid
SRC-PORT : Source optical Pid
SRC-AU : Source high order PathId
SRC-TU : Source low order PathId
SRC-MAPAU : In bus ID of the orresponding low order cross connection chip
Output Format DST-BD : Destination Bid
DST-PORT : Destination optical Pid
DST-AU : Destination high order PathId
DST-TU : Destination low order PathId
DST-MAPAU : Out bus ID of the orresponding low order cross connection chip (reserved; always 0)
LEVEL : Cross connection level
STATUS : Add/Delete operation status

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 188 of 243

:cfg-get-condxc:5,1,1,6,1,1,all-level

CROSS-CONNECTION

Example ID SRC-BD SRC-PORT SRC-AU SRC-TU SRC-MAPAU

1 5 1 1 1 1
DST-BD DST-PORT DST-AU DST-TU DST-MAPAU LEVEL STATUS
6 1 1 1 0 vc12 active
Total records :1

Precautions ¡¡

Remarks ¡¡

2.2.7 Query the cross connection low order services: cfg-get-bdlowxc

Name cfg-get-bdlowxc

Function Query the cross connection low order services.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-bdlowxc:txc-bid,in-au4bus,out-au4bus
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Bid of low order cross connection chip: Meaningless

Input Parameters
2 Source bus (VC4) ID: 0-32 (0 refers to all source VC4¡¯ s.)

Destination bus (VC4) ID: 0-32 (0 refers to all destination

3
VC4¡¯ s.)

Return the following relevant fields in the table format:

ID : Low order service ID
BID : Bid of low order cross connection chip
SRC-MAPAU : Source bus ID
Output Format
SRC-TU : Source low order PathId
DST-MAPAU : Destination bus ID
DST-TU : Destination low order PathId
LEVEL : XcLevel

:cfg-get-bdlowxc:2,1,1

BDSIDE-LOW-XC
Example
BID ID SRC-MAPAU SRC-TU DST-MAPAU DST-TU LEVEL
2 1 1 1 1 1 vc3
Total records :1

Precautions Query this command directly on the cross connection unit.

Remarks ¡¡

2.3 Linear Multiplex Section Commands

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007
OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 189 of 243

2.3.1 Create a linear MSP Group: cfg-add-lmspg

Name cfg-add-lmspg

Function To create a linear MSP group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-add-lmspg:PgId,ProtType,WorkChnNum,RvtMode,OpMode
Input Format
Number of parameters: 5; parameters not repetitive.

Parameter location Parameter meaning and value

Protection Group ID:

1 OSN 3500:1~40
OSN 2500:1~12

Protection type:
Value Meaning
2
1j1 1+1
1pn 1:N
Input Parameters
3 Number of working paths: 1£14

Revert mode:
Value Meaning
4
rvt Revert mode
norvt Non-revert mode

Uni-/bi-directional mode:
Value Meaning
5
uniend Uni-directional mode
biend Bi-directional mode

Output Format ¡¡

Example :cfg-add-lmspg:1,1pn,1,rvt,biend

This command is used when the protection group does not exist, or when restoring the deleting operation.
Precautions
It is not allowed to use this command to creat multiple linear protection groups by repeating the parameters.

For 1j1, you can choose the revert or non-revert mode, the uni-directional or bi-directional mode; while for 1pn, you
Remarks must choose the revert mode and the bi-directional mode. The protection group will be valid when the mapping
configuration for all the optical port is completed.

2.3.2 Delete a linear MSP group: cfg-del-lmspg

Name cfg-del-lmspg

Function To delete a linear MSP group.

Command Level System maintenance

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 190 of 243

Version 5.21.01

:cfg-del-lmspg:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 protection group ID: 1~40

Output Format ¡¡

Example :cfg-del-lmspg:1&2

Precautions ¡¡

Remarks The deleting action is effective when the verification is performed successfully.

2.3.3 Query all the linear MSP groups: cfg-get-lmspg

Name cfg-get-lmspg

Function To query all the linear MSP groups.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lmspg
Input Format
Number of parameters: 0; parameters not repetitive.

Return the following relevant fields in the table format:

PG-ID: Protection group ID
PROT-TYPE : Protection type
Output Format WORK-CHN-NUM : Number of working paths
REVERT-MODE : Revert mode
OP-MODE : Uni-directional/Bi-directional mode
ACTIVE-FLAG: Current status(adding/deleting/active) ¡¡

:cfg-get-lmspg:

LMS-PROTECTION-GROUP
Example
PG-ID PROT-TYPE WORK-CHN-NUM REVERT-MODE OP-MODE ACTIVE-FLAG
1 1pn 3 rvt biend adding
Total records :1

Precautions ¡¡

Remarks

2.3.4 Set the waiting time for the linear MSP group recovery: cfg-set-lmsattrib

Name cfg-set-lmsattrib

Function To set the waiting time for the linear MSP group recovery.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 191 of 243

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmsattrib:PgId, WtrTime
Input Format
Number of parameters: 2; parameters not repetitive.

Parameter location Parameter meaning and value

1 Protection group ID: 1~40

Input Parameters
Waiting time for recovery: 6~720 second; the default value is
2
600 seconds.

Output Format ¡¡

Example :cfg-set-lmsattrib:1, 300

Precautions ¡¡

Remarks This command supports modifying the active protection group.

2.3.5 Query the waiting time for the linear MSP group recovery: cfg-get-lmsattrib

Name cfg-get-lmsattrib

Function To query the waiting time for the linear MSP group recovery.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lmsattrib:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Return the following relevant fields in the table format:

Output Format PG-ID : Protection group ID
WTR-TIME : Waiting time for recovery

:cfg-get-lmsattrib:1
LMS-WTRTIME
Example PG-ID WTR-TIME
1 300
Total records :1

Precautions Return in the unit of second.

Remarks ¡¡

2.3.6 Set the signal degrading flag for the protection group: cfg-set-lmssdflag

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 192 of 243

Name Cfg-set-lmssdflag

Function To set the signal degrading flag for the protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmssdflag:PgId,EnableFlag
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID : 1~40

Input Parameters SD flag:

Vlaue Meaning
2 enable Enable the SD switch
disable Diable the SD switch
Default: enable

Output Format ¡¡

Example :cfg-set-lmssdflag:1&2&&5,enable

Precautions ¡¡

Remarks This command supports configuring the active protection group.

2.3.7 Query the degrading flag of the protection group: cfg-get-lmssdflag

Name cfg-get-lmssdflag

Function To query the degrading flag of the protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lmssdflag:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Return the following relevant fields in the table format:

Output Format
PG-ID: Protection group ID
SD-ENABLE : SD switch flag

:cfg-get-lmssdflag:1
LMS-SD-ENABLE
Example
PG-ID SD-ENABLE
1 enable

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 193 of 243

Total records :1

Precautions ¡¡

Remarks ¡¡

2.3.8 Set the port mapping relationship of the linear MS protection unit: cfg-set-lmsbdmap

Name Cfg-set-lmsbdmap

Function To set the port mapping relationship of the linear MS protection unit.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-lmsbdmap:PgId,PuId,Bid,Pid
Input Format
Number of parameters: 4; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~40

Protection unit ID: 0~14 (0~1 for the 1j1 LMS; 0~N for the
2 1pn LMS; 0 is the protection unit, and others are working
Input Parameters units.)

Board ID: 1-8, 11-16£¬17£¨80G XCS board£©; 1-8, 11-16

3
£¨40G XCS board£©

Port ID: 1-X (Determine X according to the board type

4
installed on this board.)

Output Format ¡¡

Example :cfg-set-lmsbdmap:1,0,5,1

The board must be installed before the configuration; pay attention to the board type and the optical port level;
Precautions
make sure the optical resources are available.

This command does not support configuring the active protection group. The added protection group is valid
Remarks
when the mapping configuration of all the optical ports is completed.

2.3.9 Query the port mapping relationship of the linear MS protection unit: cfg-get-lmsbdmap

Name cfg-get-lmsbdmap

Function To query the port mapping relationship of the linear MS protection unit.

Command Level System monitoring

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 194 of 243

:cfg-get-lmsbdmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Output Format ¡¡

Example :cfg-get-lmsbdmap:1&2

Precautions ¡¡

Remarks Report the multiple protection units in various messages.

2.3.10 Start the linear MS protocol controller: cfg-start-lms

Name cfg-start-lms

Function To start the linear MS protocol controller.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-start-lms:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Output Format ¡¡

Example :cfg-start-lms:1&2

Precautions ¡¡

Remarks When excuting this command, the relevant protection group must be in the active status.

2.3.11 Stop the linear MS protocol controller: cfg-stop-lms

Name cfg-stop-lms

Function To stop the linear MS protocol controller.

Command Level System operation

Available to User level

Version 5.21.01

Input Format :cfg-stop-lms:PgId

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 195 of 243

Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Output Format ¡¡

Example :cfg-stop-lms:1&2

Precautions ¡¡

When excuting this command, the relevant protection group must be in the active status. The alarm of stopping
Remarks
the MS protocol will be reported when this command is configured successfully.

2.3.12 Initiate the external switchover command of the linear MSP group: cfg-set-lmsswitch

Name cfg-set-lmsswitch

Function To initiate the external switchover command of the linear MSP group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmsswitch:PgId,PuId,SwCmd
Input Format
Number of parameters: 3; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~40

2 Protection unit ID: 0~14 (0~1 for the 1j1 LMS, and 0~N for the 1pn LMS.)

External switchover command types:

value meaning
Input Parameters lms-lock Lock the protection channel
lms-unlock Unlock the protection channel
lms-force Force switch
3 lms-forceclr Clear the force switch
lms-man Manual switch
lms-manclr Clear the manual switch
lms-exer Exercise switch
lms-exerclr Clear the exercise switch

Output Format ¡¡

Example :cfg-set-lmsswitch:1,1,lms-force

Precautions ¡¡

The relevant protection group is in the active status. The lms-lock command applies to the protection channel only; the
Remarks lms-force and lms-man commands can apply to both the working and protection channels; the lms-exer command applies
to the working channel only.

2.3.13 Query the switchover status of the linear MS protection group: cfg-get-lmsstate

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 196 of 243

Name cfg-get-lmsstate

Function To query the switchover status of the linear MS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lmsstatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Return the following relevant fileds in the table format:

PG-ID: Protection group ID

Output Format
PU-ID: Protection unit ID
SWITCH-REQUEST: Switchover request
SWITCH-STATUS: Switchover status

:cfg-get-lmsstatus:1
LMS-SWITCH-STATUS
PG-ID PU-ID SWITCH-REQUEST SWITCH-STATUS
Example
1 0 LPS_LP S
Total records :1

Precautions ¡¡

Remarks ¡¡

2.3.14 Query the switchover event logs of the Linear MS protection group: cfg-get-lmsevent

Name cfg-get-lmsevent

Function To query the switchover event logs of the linear MS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-lmsevent:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Return the following relevant fields in the table format:

Output Format PG-ID: Protection group ID
EVENT-NO: Event ID
EVENT-VALUE: Event value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 197 of 243

EVENT-PARA: Event parameter

DATE-TIME: Date and time
TIME-STAMP: Time stamp

Example :cfg-get-lmsevent:1&2

Precautions ¡¡

Remarks ¡¡

2.3.15 Clear the switchover event logs of the linear MS protection group: cfg-init-lmsevent

Name cfg-init-lmsevent

Function To clear the switchover event logs of the linear MS protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-init-lmsevent:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~40

Output Format ¡¡

Example :cfg-init-lmsevent:1&2

Precautions ¡¡

Remarks ¡¡

2.3.16 Set the switchover holdoff time of the linear MS protection group: cfg-set-lmsholdofftime

Name cfg-set-lmsholdofftime

Function To set the switchover holdoff time of the liner MS protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmsholdofftime:PgId,holdofftime
Input Format
Number of parameters: 2; parameters not repetitive.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection Group ID: 1~40

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 198 of 243

¡¡ 2 Hold-off time : 0 ~100 (Default: 0; unit: 100ms)

Output Format ¡¡

Example :cfg-set-lmsholdofftime:1,100

Precautions ¡¡

Remarks ¡¡

¡¡

2.3.17 Query the switchover holdoff time of the linear MS protection group: cfg-get-
lmsholdofftime

Name cfg-get-lmsholdofftime

Function To query the switchover holdoff time of the linear MS protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-lmsholdofftime:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~40

Return the following relevant field:

Output Format
HOLDOFF-TIME: Reporting time for the switchover delay

:cfg-get-lmsholdofftime:1
Example
HOLDOFF-TIME : 100

Precautions ¡¡

Remarks ¡¡

2.3.18 Set the k2 mode of the linear MS protection group: cfg-set-lmsk2mode

Name cfg-set-lmsk2mode

To set the k2 mode (whether the last three bits of k2 indicate the uni-/bi-directional mode) of the linear MS
Function
protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmsk2mode:PgId,k2mode
Input Format
Number of parameters: 2; parameter blocks repeated.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 199 of 243

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~40

Whether the last three bits of K2 indicate the uni-/bi-directional

mode:
value meaning
¡¡ 2
indicate Indicate the uni-/bi-directional mode
noindicate Not indicate the uni-/bi-directional mode
Defaule: noindicate

Output Format ¡¡

Example :cfg-set-lmsk2mode:1,indicate

Precautions ¡¡

Remarks ¡¡

¡¡

2.3.19 Query the k2 mode of the linear MS protection group: cfg-get-lmsk2mode

Name cfg-get-lmsk2mode

To query the k2 mode (whether the last three bits of k2 indicate the uni-/bi-directional mode) of the linear MS
Function
protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-lmsk2mode:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~40

Return the following relevant field:

Output Format
K2-MODE: Whether the last three bits of k2 indicate the uni-/bi-directionalmode.

:cfg-get-lmsk2mode:1
Example
K2-MODE : indicate

Precautions ¡¡

Remarks ¡¡

¡¡

2.3.20 Set the priority of the linear MS SF and SD in the K bytes: cfg-set-lmsklevel

Name cfg-set- lmsklevel

Function Set the priority of the linear MS SF and SD in the K bytes.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 200 of 243

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-lmsklevel:PgId,klevel
Input Format
Number of parameters: 2; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~40

Priority of SF and SD in the K bytes:

Value Meaning
¡¡ 2 k_high High level
k_low Low level
Default: k_high

Output Format ¡¡

Example :cfg-set-lmsklevel:1,k_low

This command is only used in interconnection with devices of other manufacturers. Please be cautious with this
Precautions
command.

Remarks ¡¡

¡¡

2.3.21 Query the priority of the linear MS SF and SD in the K bytes: cfg-get-lmsklevel

Name cfg-get-lmsklevel:

Function Query the priority of the linear MS SF and SD in the K bytes.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-lmsklevel:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~40

Output Format K-LEVEL: Priority of SF and SD in the K bytes

:cfg-get-lmsklevel:1
Example
K-LEVEL : k_low

This command is only used in interconnection with devices of other manufacturers. Please be cautious with this
Precautions
command.¡¡

Remarks ¡¡

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 201 of 243
¡¡

2.4 Ring Multiplex Section Commands

2.4.1 Create a Ring MS protection group: cfg-add-rmspg

Name cfg-add-rmspg

Function To create a ring MS protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-add-rmspg:PgId,Type
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

Input Parameters Protection group types:

value meaning
2 2fbi Two fiber bidirectional ring
2funi Two fiber unidirection ring
4f Four fiber ring

Output Format ¡¡

Example :cfg-add-rmspg:1&2, 2fbi

Precautions This command is used when the protection does not exist or in restoring the deleting operation.

After adding the protection group, perform the verification when the mapping configuration for all the optical
Remarks
ports is completed; otherwise, error may occur.

2.4.2 Delete a Ring MS protection group: cfg-del-rmspg

Name cfg-del-rmspg

Function To delete a Ring MS protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-del-rmspg:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 202 of 243

1 Protection group ID: 1~12

Output Format ¡¡

Example :cfg-del-rmspg:1&2

Precautions ¡¡

Remarks The deleting action becomes effective after the verification.

2.4.3 Query all the MS Ring protection groups: cfg-get-rmspg

Name cfg-get-rmspg

Function To query all the MS ring protection groups.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmspg
Input Format
Number of parameters: 0; parameters not repetitive.

Return the following relevant fields in the table format:

PG-ID: Protection group ID
Output Format
TYPE : Protection group type
ACTIVE-STATE: Protection group status (adding/deleteing/active)¡¡

:cfg-get-rmspg
MSSPR-PROTECTION-GROUP
PG-ID TYPE ACTIVE-STATUS
Example
1 2fbi adding
2 2fbi adding
Total records :2

Precautions ¡¡

Remarks ¡¡

2.4.4 Set the attributes of the MS ring protection group: cfg-set-rmsattrib

Name cfg-set-rmsattrib

Function To set the attributes of the MS ring protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-rmsattrib:PgId, LocalNode, WestNode, EastNode, WtrTime

Input Format
Number of parameters: 5; parameter blocks repeated.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 203 of 243

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

2 Local node ID: 0~15; the default is 1.

West node ID: 0~15 (The old protocol node ID must be

Input Parameters 3 consecutive, and the east node ID must larger than the west
node ID); the default is 0.

East node ID: 0~15 (The old protocol node ID must be

4 consecutive, and the east node ID must larger than the west
node ID); the default is 2.

Waiting time for recovery: 6~720 seconds; the default is 600

5
seconds.

Output Format ¡¡

Example :cfg-set-rmsattrib: 1, 2, 3, 4, 200

The ID of the local, east and west nodes should be mutually different; the ID can be configured following certain
Precautions regularity; for example, to dynamically configure the attributes of the protection group in the clockwise direction;
to activate a protection group is taken as modification.

Remarks

2.4.5 Query the attributes of the MS ring protection group: cfg-get-rmsattrib

Name cfg-get-rmsattrib

Function To query the attributes of the MS ring protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmsattrib:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

PG-ID: Protection group ID

Output Format LOCAL-NODEID : Local node ID
WEST-NODEID : West node ID
EAST-NODEID : East node ID
WTR-TIME: Waiting time for recovery

:cfg-get-rmsattrib:1
MSSPR-PG-ATTRIBUTE
Example PG-ID LOCAL-NODEID WEST-NODEID EAST-NODEID WTR-TIME
1 2 3 4 200
Total records :1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 204 of 243

Precautions ¡¡

Remarks

2.4.6 Set the degrading flag of the MS ring protection group: cfg-set-rmssdflag

Name cfg-set-rmssdflag

Function To set the degrading flag of the MS ring protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-rmssdflag:PgId,Flag
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

Input Parameters
SD flag: value meaning
enable Enable the SD switch
2
disable Disable the SD switch
Default: enable

Output Format ¡¡

Example :cfg-set-rmssdflag:1&2,enable

Precautions ¡¡

Remarks

2.4.7 Query the degrading flag of the MS ring protection group: cfg-get-rmssdflag

Name cfg-get-rmssdflag

Function To query the degrading flag of the MS ring protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmssdflag:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 205 of 243

Output Format PG-ID: Protection group ID

SD-ENABLE: SD flag

MSSPR-SD-ENABLE
PG-ID SD-ENABLE
Example
1 enable
Total records :1

Precautions ¡¡

Remarks

2.4.8 Set the port mapping relationship of the MS ring protection unit: cfg-set-rmsbdmap

Name cfg-set-rmsbdmap

Function Set the port mapping relationship of the MS ring protection unit.
Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-rmsbdmap:PgId,PuId,Bid,Pid,AuTable
Input Format
Number of parameters: 5; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

Protection unit ID:

Value Meaning
w1 west1
2
w2 west2
e1 east1
Input Parameters e2 east2

SDH board ID: 2~8£¬11-16£¬17£¨80G XCS board£©£»

3
2~8£¬11-16£¨40G XCS board£©

Port ID: 1~X (X is the max number of the optical ports on an optical
4
board; determined according to the board type.)

5 AU4 utilization flag: Determined according to the port level.

Output Format ¡¡

Example :cfg-set-rmsbdmap:1,w1,5,1,1&&4&8

1. The configuration requires the installation of the board; the board type is specified to the line board; the optical
resources must be available. The optical port with the rate level as STM-1 should not be the protection unit of the two
fiber bi-directional ring MS.
2. The Metor 3500 boards of two rate levels (STM-64 and STM-16) support the configuration of shared optical
Precautions channel. That is, a 10G optical port can be used as two (one uplink 5G and one downlink 5G) optical ports, and can
also be used as a single 10G optical port; a 2.5G optical port can be used as two (one uplink 2.5G and one downlink
2.5G) optical ports, and can also be used as a single 2.5G optical port.
3. The AU4 utilization flag should not exceed the number of actual VC4 channels of the optical port.
4. If the protection group is of two fiber bi-directional type, the AU4 utilization flag should not be any channel among

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 206 of 243

the latter half channels of the optical port currently in use.

This command does not support configuring the active protection group. After adding a protection group, perform the
Remarks
verification when the mapping configuration for all the optical ports is completed; otherwise, error may occur.

2.4.9 Query the port mapping relationship of the MS ring protection unit: cfg-get-rmsbdmap

Name Cfg-get-rmsbdmap

Function To query the port mapping relationship of the MS ring protection unit.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmsbdmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

PG-ID: Protection group ID

Output Format PU-ID: Protection unit ID
BOARD-ID : SDH board ID
PORT-ID : Port ID
AU4-MAP: AU4 utilization flag

:cfg-get-rmsbdmap:1
PG-ID PU-ID BOARD-ID PORT-ID AU4-MAP
Example
1 west1 5 1 1&&8&16&&32
1 east1 5 1 1&&8&16&&32

Precautions ¡¡

Remarks Report the multiple protection units in various messages.

2.4.10 Start the MS ring protocol controller: cfg-start-rms

Name cfg-start-rms

Function To start the MS ring protocol controller.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-start-rms:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 207 of 243

Input Parameters 1 Protection group ID: 1~12

Output Format ¡¡

Example :cfg-start-rms:1&2

Precautions ¡¡

Remarks The relevant protection group should be in the active status.

2.4.11 Stop the MS ring protocol controller: cfg-stop-rms

Name cfg-stop-rms

Function To stop the MS ring protocol controller.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-stop-rms:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Output Format ¡¡

Example :cfg-stop-rms:1&2

Precautions ¡¡

Remarks The relevant protection group should be in the active status.

2.4.12 Initiate the external switchover command of the MS ring: cfg-set-rmsswitch

Name Cfg-set-rmsswitch

Function To initiate the external switchover command of the MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-rmsswitch:PgId,SwDir,SwCmd
Input Format
Number of parameters: 3; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 208 of 243

Switch direction:
Value Meaning
2
w1 west
e1 east

Types of extrernal switchover commands:

value meaning
rms-lock Lock
rms-unlock Unlock
rms-sforce Section force switch
Input Parameters rms-sforceclr Clear the section force switch
rms-rforce Ring force switch
rms-rforceclr Clear the ring force switch
3
rms-sman Section manual switch
rms-smanclr Clear the section manual switch
rms-rman Ring manual switch
rms-rmanclr Clear the ring manual switch
rms-sexer Section exercise switch
rms-sexerclr Clear the section exercise switch
rms-rexer Ring exercise switch
rms-rexerclr Clear the ring exercise switch

Output Format

Example :cfg-set-rmsswitch:1,w1,rms-rman

Precautions ¡¡

Remarks The relevant protection group should have been started.

2.4.13 Query the switchover status of the MS ring protection group: cfg-get-rmsstate

Name cfg-get-rmsstate

Function To query the switchover status of the MS ring protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmsstatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

PG-ID: Protection group ID

WEST-SWREQ: West switchover request
Output Format WEST-SWSTA: West switchover status
WEST-SWFLAG: West switchover flag
EAST-SWREQ: East switchover request
EAST-SWSTA: East switchover status
EAST-SWFLAG: East switchover flag

:cfg-get-rmsstatus:1
MSSPR-SWITCH-STATUS

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 209 of 243

PG-ID WEST-SWREQ WEST-SWSTA WEST-SWFLAG EAST-SWREQ EAST-SWSTA EAST-SWFLAG

Example
1 SF_R S ON SF_R IDLE OFF
Total records :1

Precautions ¡¡

Remarks The relevant protection group should have been started.

2.4.14 Query the event Logs of the MS ring protection group: cfg-get-rmsevent

Name cfg-get-rmsevent

Function To query the event logs of the MS ring protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-rmsevent:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

PG-ID : Protection group ID

EVENT-NO: Event No.
Output Format
EVENT-VALUE: Event value
EVENT-PARA: Event parameter
DATE-TIME: Date and time
TIME-STAMP: Time stamp

Example :cfg-get-rmsevent:1&2

Precautions ¡¡

Remarks ¡¡

2.4.15 Initialize the event logs of the MS switchover process: cfg-init-rmsevent

Name cfg-init-rmsevent

Function To initialize the event logs of the MS switchover process.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-init-rmsevent:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 210 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Output Format ¡¡

Example :cfg-init-rmsevent:1&2

Precautions ¡¡

Remarks ¡¡

2.4.16 Set the protocol type of the MS ring protection group: cfg-set-rmsprotocol

Name cfg-set-rmsprotocol

Function To set the protocol type of the MS ring protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set- rmsprotocol:PgId,Flag
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~12

Input Parameters
Protocol type flag: old - old protocol type; new - new protocol
2
type; the default is new.

Output Format ¡¡

Example :cfg-set- rmsprotocol:1&2£¬new

Precautions Stop the protocol before changing the protocol type of the protection group.

Remarks ¡¡

2.4.17 Query the protocol type of the MS ring protection group: cfg-get- rmsprotocol

Name cfg-get- rmsprotocol

Function To query the protocol type of the MS ring protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get- rmsprotocol:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 211 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Return the following relevant fields in the table format:

Output Format PG-ID: Protection group ID
PROTOCOL-TYPE : Protocol type

:cfg-get- rmsprotocol:1
MSSPR-PROTOCOL-TYPE
Example PG-ID PROTOCOL-TYPE
1 old
Total records :1

Precautions ¡¡

Remarks ¡¡

2.4.18 Set the holdoff time for the MS ring switchover: cfg-set-rmsholdofftime

Name cfg-set-rmsholdofftime

Function To set the holdoff time for the MS ring switchover.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-rmsholdofftime:PgId,holdofftime
Input Format
Number of parameters: 2; parameters not repetitive.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

¡¡ 2 Holdoff time: 0 ~100 (Default: 0; unit: 100ms)

Output Format ¡¡

Example :cfg-set-rmsholdofftime:1,100

Precautions ¡¡

Remarks ¡¡

2.4.19 Query the holdoff time for the MS ring switchover: cfg-get-rmsholdofftime

Name cfg-get-rmsholdofftime

Function To query the holdoff time for the MS ring switchover.

Command Level System operation

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 212 of 243

Version 5.21.01

:cfg-get-rmsholdofftime:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Return the following relevant field:

Output Format
HOLDOFF-TIME: Hold off time

:cfg-get-rmsholdofftime:1
Example
HOLDOFF-TIME : 100

Precautions ¡¡

Remarks

2.4.20 Query the locking status of the MS ring: cfg-get-rmslock

Name cfg-get-rmslock

Function To query the locking status of the MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-rmslock:PgId
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~12

Output Format ¡¡

Example :cfg-get-rmslock:1

Precautions ¡¡

Remarks This command applies to the old protocol only; it does not support the new protocol.

2.4.21 Set the enabling flag of the MS ring service suppression: cfg-set-rmssquflag

Name cfg-set-rmssquflag

Function To set the enabling flag of the MS ring service suppression.

Command Level System operation

Available to User level

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 213 of 243

Version 5.21.01

:cfg-set-rmssquflag:PgId,Flag
Input Format
Number of parameters: 2; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Service suppression enabling flag:

value meaning
¡¡ 2 enable Enable the service suppression
disable Disable the service suppression
Default: enable

Output Format ¡¡

Example :cfg-set-rmssquflag:1,disable

Precautions ¡¡

Remarks ¡¡

2.4.22 Query the enabling flag of the MS ring service suppression: cfg-get-rmssquflag

Name cfg-get-rmssquflag

Function To query the enabling flag of the MS ring service suppression.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-rmssquflag:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Return the following relevant field:

Output Format
SQUELCH-ENABLE: Enabling flag of the MS ring service suppression

:cfg-get-rmssquflag:1
MSSPR-SQUELCH-ENABLE
Example PG-ID SQUELCH-ENABLE
1 enable
Total records :1

Precautions ¡¡

Remarks

2.4.23 Set the node configuration table for the whole MS ring: cfg-set-rmsnodemap

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 214 of 243

Name cfg-set-rmsnodemap

Function Set the node configuration table for the whole MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-rmsnodemap:PgId,NodeCnt,Node1,Node2..Node8
Input Format
Number of parameters: 10; single parameter repetitive.

Input Parameters Parameter location Parameter meaning and value

1 Protection group: 1~12

2 Number of nodes on the whole ring: 2~16

Node number parameter 1: Each parameter stands for two nodenumbers; value
3
range for each node number is 0~15.

4 Node number parameter 2: Same as above.

¡¡ 5 Node number parameter 3: Same as above.

¡¡
6 Node number parameter 4: Same as above.

7 Node number parameter 5: Same as above.

8 Node number parameter 6: Same as above.

9 Node number parameter 7: Same as above.

10 Node number parameter 8: Same as above.

Output Format ¡¡

:cfg-set-rmsnodemap:1&2,16,0x0001,0x0203,0x0405,0x0607,0x0809, 0x0a0b,
Example
0x0c0d, 0x0e0f

Nodes on the whole ring should be configured according to the actual networking, from west to east; otherwise, the
Precautions
configuration will not work.

Remarks Deliver this command only when the protection group is in the active status.

2.4.24 Query the node configuration table for the whole MS ring: cfg-get-rmsnodemap

Name cfg-get-rmsnodemap

Function To query node configuration table for the whole MS ring.

Command Level System operation

Available to User level

Version 5.21.01

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 215 of 243

:cfg-get-rmsnodemap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Return the following relevant fields:

Output Format NODE-CNT: Number of nodes on the whole ring
NODE: Node number

:cfg-get-rmsnodemap:1
MSSPR-NODEMAP
Example PG-ID NODE-CNT NODE NODE NODE NODE NODE NODE NODE NODE
1 0 0xffff 0xffff 0xffff 0xffff 0xffff 0xffff 0xffff 0xffff
Total records :1

Precautions ¡¡

Remarks

2.4.25 Add the suppression service for the MS ring: cfg-add-rmsringmap

Name Cfg-add-rmsringmap:

Function To add the suppression service for the MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-add-rmsringmap:PgId,Dir,Vc4Id,SrcNode,DstNode,IsLowVc4Used
Input Format
Number of parameters: 6; single parameter repetitive.

Input Parameters Parameter location Parameter meaning and value

1 Protection group ID: 1~12

2 Service direction: west or east

3 VC4PathId: 1~64
¡¡
¡¡
4 Source node number: 0~15

5 Destination node number: 0~15

6 Utilization flag of the low order service: Reserved byte

Output Format ¡¡

Example :cfg-add-rmsringmap:1,west,1,1,15,0

Precautions ¡¡

Remarks Deliver this command only when the protection group is in the active status.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 216 of 243

2.4.26 Query the suppression service of the MS ring: cfg-get-rmsringmap

Name cfg-get-rmsringmap

Function To query the suppression service of the MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-rmsringmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Return the following relevant fields:

PG-ID: Protection group ID
DIR: Suppression service direction
Output Format AU4ID: VC4PathId
SRC-NODE: Source node number
DST-NODE: Destination node number
LOWVC4-USED: Utilization flag of the low order service (currently unusable)

:cfg-get-rmsringmap:1
MSSPR-RINGMAP
PG-ID DIR AU4ID SRC-NODE DST-NODE LOWVC4-USED
Example
1 west 1 1 15 0
1 east 2 5 1 0
Total records :2

Precautions ¡¡

Remarks

2.4.27 Delete the suppression service of the MS ring: cfg-del-rmsringmap

Name cfg-del-rmsringmap

To delete the suppression service of the MS ring. This command deletes only one designated suppression
Function
service.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-del-rmsringmap:PgId,Dir,Vc4Id
Input Format
Number of parameters: 3; single parameter repetitive.

Input Parameters Parameter location Parameter meaning and value

1 Protection group ID: 1~12

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 217 of 243

2 Suppression service direction: West or east

¡¡
3 VC4PathId: 1~64

Output Format

Example :cfg-del-rmsringmap:1&2,west,1

Precautions ¡¡

Remarks Deliver this command only when the protection group is in the active status.

2.4.28 Clear the suppression service of the MS ring: cfg-clear-rmsringmap

Name cfg-clear-rmsringmap

To clear the suppression service of the MS ring. This command deletes all the sppression services (including
Function
that of the MS) of the protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-clear-rmsringmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

¡¡ 1 Protection group ID: 1~12

Output Format

Example :cfg-clear-rmsringmap:1&2

Precautions ¡¡

Remarks Deliver this command only when the protection group is in the active status.

2.4.29 Query the service suppression status of the MS ring: cfg-get-rmssquflag

Name cfg-get-rmssqustatus

Function To query the service suppression status of the MS ring.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-get- rmssqustatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Input Parameters Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 218 of 243

¡¡ 1 Protection group ID: 1~12

Return the following relevant fields:

Output Format SQUELCH-STATUS: Service suppression status of the MS ring (suppress or not)
NODE-STATUS: Node status (isolated or not)

:cfg-get-rmssqustatus:1
MSSPR-SQUELCH-STATUS
Example PG-ID SQUELCH-STATUS NODE-STATUS
1 NO-SQUELCH NO-LONE
Total records :1

Precautions ¡¡

Remarks

2.5 SNCP Commands

2.5.1 Add an SNCP group: cfg-add-sncppg

Name cfg-add-sncppg

Function To add an SNCP group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-add-sncppg:PgId, RvtMode
Input Format
Number of parameters: 2; parameters repeated.

Parameter location Parameter meaning and value

Protection group ID: 1~1184

Input Parameters 1
Parameters repeatitive; the max number of protection groups
is 1184.

2 Revert mode: rvt or norvt

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-add-sncppg:1&2,rvt

Precautions Use this command when the protection group does not exist or when recoverying the deleting operation.

Remarks

2.5.2 Delete an SNCP group: cfg-del-sncppg

Name cfg-del-sncppg

Function To delete an SNCP group.

Command Level System maintenance

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 219 of 243

Available to User level

Version 5.21.01

:cfg-del-sncppg:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters Protection group ID: 1~1184

1 Parameters repetitive; the max number of protection groups
is 1184.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-del-sncppg:1&2

Precautions

Remarks The deleting action becomes effective after the verification.

2.5.3 Query all the SNCP groups: cfg-get-sncppg

Name cfg-get-sncppgp

Function To query all the SNCP groups.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-sncppg

PG-ID : Protection group ID

Output Format REVERT-MODE : Revert mode
ACTIVE-FLAG : Current status (active/adding/deleting)

:cfg-get-sncppg
SNCP-PROTECTION-GROUP
Example PG-ID REVERT-MODE ACTIVE-FLAG
1 rvt adding
Total records :1

Precautions

Remarks To query the ID, revert mode and activating status of all the protection groups.

2.5.4 Set the revert mode and waiting time for recovery for the SNCP group: cfg-set-sncppgpara

Name cfg-set-sncppgpara

Function To set the revert mode and waiting time for recovery for the SNCP group.
Command Level System operation

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 220 of 243

Available to User level

Version 5.21.01

:cfg-set-sncppgpara:PgId£¬RvtMode £¬WtrTime
Input Format
Number of parameters: 3; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~1184

Input Parameters
2 Revrt mode: rvt or norvt

Waiting time for recovery: 6~720 seconds; the default is 600

3
seconds.

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-sncppgpara:1&2,rvt,300

Precautions

Remarks

2.5.5 Query the revert mode and waiting time for recovery fot the SNCP group: cfg-get-
sncppgpara

Name Cfg-get-sncppgpara

Function To query the revert mode and waiting time for recovery for the SNCP group.
Command Level System operation

Available to User level

Version 5.21.01

:cfg-get-sncppgpara:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~1184¡£

Return the following relevant fields in the table format:

PG-ID : Protection group ID
Output Format
REVERT-MODE : Revert mode
WTR-TIME : Waiting time for recovery

Example :cfg-get-sncppgpara:PgId

Precautions

Remarks ¡¡

2.5.6 Set the port mapping relationship for the SNCP unit: cfg-set-sncpbdmap

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 221 of 243

Name cfg-set-sncpbdmap

Function To set the port mapping relationship for the SNCP unit.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-sncpbdmap:PgId,PuId,SrcBid,SrcPid,SrcAu4Id,SrcPath,DstBid,DstPid,DstAu4Id,DstPath,XcLevel
Input Format
Number of parameters: 11; parameters not repetitive.

Parameter
Parameter meaning and value
location

Protection group ID: 1~1184

1
Parameters repetitive; the max number of protection groups is 1184.

Protection unit ID:

Value Meaning
2
work Working unit
backup Protection unit

3 Source board ID: 1-8, 11-16£¬17 (80G XCS board)

4 Source port ID: 1-X (Determine X according to the board type.)

5 Source high order path ID: 1-X (Determine X according to the port level of this board type.)

6 Souce low order path ID: 1-X (Determine X according to the board type.)
Input Parameters
7 Dest board ID: 1-8, 11-16£¬17 (80G XCS board)

8 Dest port ID: 1-X (Determine X according to the board type.)

9 Dest high order path ID: 1-X; determined by the optical port level; adopt 0 if the board is a tributary board.

10 Destination low order PathId: 1-63; determined by the board type; adopt 0 if the board is a tributary board.

Service level:

Value Meaning
vc12 Commom vc12 traffic
vc3 Common vc3 traffic
11
vc4 Common VC4 traffic
au4-4c Concatenation traffic
au4-8c Concatenation traffic
au4-16c Concatenation traffic
au4-64c Concatenation traffic

Output Format ¡¡

Example :cfg-set-sncpbdmap:1,work,5,1,4,0,6,1,2,0,vc4

Install the board before the configuration; pay attention to the board type and the optical port level; make sure the optical port resources are
Precautions
available.

It is necessary to send the cfg-verify command. Refer to the cfg-add-xc command (Create the cross connection) for setting the input from 3 to
Remarks
11.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 222 of 243

2.5.7 Query the port mapping relationship of the SNCP unit: cfg-get-sncpbdmap

Name cfg-get-sncpbdmap

Function To query the port mapping relationship of the SNCP unit.

Command
System monitoring
Level

Available to User level

Version 5.21.01

:cfg-get-sncpbdmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter
Parameter meaning and value
location
Input
Parameters
PgId: 1~1184
1
Parameters repetitive; the max number of protection groups is 1180.

:cfg-get-sncpbdmap:1
SNCP-PU-MAP
PG-ID PU-ID SRC-BID SRC-PID SRC-AU4 SRC-PATH DST-BID DST-PID DST-AU4 DST-PATH XC-LEVEL
Output Format
1 work 5 1 4 0 4 1 2 0 vc4
1 backup 2 1 1 0 4 1 2 0 vc4
Total records :2

Example :cfg-get-sncpbdmap:1

Precautions

Remarks Report the multiple protection groups in various messages.

2.5.8 Set the SNCP attributes: cfg-set-sncpattrib

Name cfg-set-sncpattrib

Function To set the SNCP attributes.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-sncpattrib:PgId,PuId,OptCondition,DelayTime
Input Format
Number of parameters: 4; parameter blocks repeated.

Parameter location Parameter meaning and value

Protection group ID: 1~1184

1
Parameters repetitive; the max number of protection groups is 1180.

Protection unit ID:

Value Meaning

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 223 of 243

work Working unit

backup Protection unit
2
The PP mode does not support setting separately the attributes of the
working and protection channels; reserve this parameter.

Monitoring condition:
Input Parameters
3 SNCP: hpuneq, b3sd, hptim, b3exc
PP: lpslm, lpuneq, lptim, bipexc, bipsd

Holdoff time: 0~100; unit: 100ms; default: 0.

4 The PP mode does not support setting the holdoff time; this parameter is
invalid, and the host does not detect this parameter.

Output Format

:cfg-set-sncpattrib:1,work,hpuneq&b3sd&hptim&b3exc,100
Example
:cfg-set-sncpattrib:2,work,lpslm&bipexc,0

Precautions

Support the dynamic configuration. The PP mode does not support setting separately the attributes of the working and
Remarks
protection channels; only the configured attributes of the working channel are valid.

2.5.9 Query the attributes of the SNCP unit: cfg-get-sncpattrib

Name cfg-get-sncpattrib

Function To query the attributes of the SNCP unit.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-sncpattrib:PgId,PuId
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

PgId: 1~1184
Input Parameters 1
The max number of protection groups is 1180.

2 PuId: work or backup

:cfg-get-sncpattrib:1,work
PgId : 1
Output Format PuId : work
OpCondition: b3sd
DelayTime : 100

Example :cfg-get-sncpattrib:1,work

Precautions The PP protection does not support the holdoff time; return 0.

Remarks

2.5.10 Initiate the SNCP external switchover command: cfg-set-sncpswitch

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 224 of 243

Name cfg-set-sncpswitch

Function To initiate the SNCP external switchover command.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-sncpswitch:PgId,ExtCmd,SwDir
Input Format
Number of parameters: 3; parameter blocks repeated.

Parameter location Parameter meaning and value

PgId: 1~1184
1
The max number of protection groups is 1184.
Input Parameters
ExtCmd: External switchover command
2
sncp-lock, sncp-clear, sncp-force

SwDir: Switch direction

3 w2p: Working to protection
p2w: Protection to work

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-sncpswitch:1,sncp-force,w2p

Precautions

The relevant protection group is in the active status. In terms of the SNCP protection group configured with the
revert mode, the switchover will fail if first switching it to the protection unit and then to the working unit using the
Remarks force or manual switchover; in terms of the SNCP protection group configured with the non-revert mode, the
clear command will becomes invalid after switching it to the protection unit using the force or manual switchover.
The non-revert SNCP protection group is in the DNR status; therefore, the clear command does not work.

2.5.11 Query the switchover status of the SNCP group: cfg-get-sncpstate

Name cfg-get-sncpstate

Function To query the switchover status of the SNCP group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-sncpstatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters PgId: 1~1184

1
The max number of protection groups is 1184.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 225 of 243

:cfg-get-sncpstatus:1
SNCP-SWITCH-STATUS
Output Format PG-ID SWITCH-SATAE
1 sncp-idle
Total records :1

Example :cfg-get-sncpstatus:1

Precautions

Remarks

2.5.12 Query the SNC node information: cfg-get-sncinfo

Name cfg-get-sncinfo

Function To query the SNC node information.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-sncinfo:Bid, PageNo, PgId, PuId

Input Format
Number of parameters: 4; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Bid: 1-8, 11-16£¬17£¨80G XCS£©

Switchover page: 0~3 (0 for the current page; 1 for the east switchover page of the MS
Input Parameters 2 ring; 2 for the west switchover page of the MS ring; 3 for the switchover page of the MS
segment.

3 PgId: 1~1184

4 PuId: work or backup

:cfg-get-sncinfo:4,0,1,work
SNC-INFO
Output Format BID PAGE-NO PG-ID PU-ID PID AU4ID SNC-ATTR DELAY-TIME SNC-STATUS
4 0 1 work 1 1 1 0 sncp-sf
Total records :1

Example :cfg-get-sncinfo:4,0,1,work

Precautions This command is delivered directly to the board. Therefore, the board should be in position.

Remarks This command applies to the SNCP high order protection only. There is no return when querying the PP protection groups.

2.5.13 Query the diversion of the SNC monitoring point: cfg-get-sncdivert

Name cfg-get-sncdivert

Function To query the diversion of the SNC monitoring point.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 226 of 243

Command Level System monitoring

Available to Internal level

Version 5.21.01

:cfg-get-sncdivert:PgId
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~1184

:cfg-get-sncdivert:4

SNC-DIVERT

Output Format PG-ID WORK-BID WORK-PID WORK-AU4ID WORK-STATUS BACK-BID BACK-PID BACK-AU4ID
1 6 1 1 idle 7 1 1

BACK-STATUS
Idle

:cfg-get-sncdivert:4

SNC-DIVERT

Example PG-ID WORK-BID WORK-PID WORK-AU4ID WORK-STATUS BACK-BID BACK-PID BACK-AU4ID

1 6 1 1 idle 7 1 1

BACK-STATUS
Idle

Precautions ¡¡

This command applies to the SNCP high order protection only. There is no return when querying the PP
Remarks
protection groups.

2.5.14 Enable reporting the SNCP switchover event: cfg-set-sncpreport

Name cfg-set-sncpreport

Function To enable reporting the SNCP switchover event.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-sncpreport: flag
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

Input Parameters
flag: enable£¬disable
1
Default: enable

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 227 of 243

Example :cfg-set-sncpreport:enable

Precautions

Remarks

2.5.15 Query the enabling status of reporting the SNCP switchover event: cfg-get-sncpreport

Name cfg-get-sncpreport

Function To query the enabling status of reporting the SNCP switchover event.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-sncpreport
Input Format
Number of parameters: 0

Parameter location Parameter meaning and value

Input Parameters

Output Format SNCP-REPORT : disable

Example :cfg-get-sncpreport

Precautions ¡¡

Remarks

2.5.16 Query the SNCP protection group with specified conditions: cfg-get-condsncp

Name cfg-get-condsncp

Function To query the SNCP protection group with specified conditions.

Command Level System monitoring

Available to Internal level

Version 5.21.01

:cfg-get-condsncp:Bid,Pid,BidAttr,XcLevel
Input Format
Number of parameters: 4

Parameter location Parameter meaning and value

1 Bid: 0-8, 11-16£¬17 (80G XCS) (0 refers to all boards.)

Pid: 0-X (Determine X according to the type of the board

2
installed on this board) (0 refers to all optical ports.)

BidAttr: Board attributes

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 228 of 243

value meaning
srcwork SNCP source working board
3
srcbackup SNCP source protection board
Input Parameters dst SNCP destination board
any any board

XcLevel: vc12£¬vc3£¬vc4£¬au4-4c£¬au4-8c£¬au4-
4
16c£¬au4-64c£¬all-level

:cfg-get-condsncp:1,0,srcwork,all-level
PG-ID RVTMODE
Output Format
1 rvt
2 rvt

Example :cfg-get-condsncp:1,0,srcwork,all-level

Precautions

Remarks

2.5.17 Creat SNCP protection groups on the basis of common services: cfg-convert-xctosncp

Name cfg-convert-xctosncp

Function To create SNCP protection groups on the basis of common services.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-convert-xctosncp:XcId,SrcBid,SrcPid,SrcAu4Id,SrcTuId,DstBid,DstPid,
DstAu4Id,DstTuId,XcLevel,PgId,ProtSrcBid,ProtSrcPid,ProtSrcAu4Id,ProtSrcTuId
Input Format
Number of parameters: 15

Parameter
Parameter meaning and value
location

1 XcId: Service ID, 1-3526

2 SrcBid: Source board ID corresponding to this service

3 SrcPid: Souce port ID corresponding to this service

4 SrcAu4Id: Source high order PathId corresponding to this service

Input Parameters 5 SrcTuId: Source low order PathId corresponding to this service

6 DstBid: Destination Bid corresponding to this service

7 DstPid: Destination optical Pid corresponding to this service

8 DstAu4Id: Destination high order PathId corresponding to this service

9 DstTuId: Destination low order PathId corresponding to this service

10 XcLevel: XcLevel corresponding to this service

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 229 of 243

11 PgId: 0-1184 (0 for auto distribution)

12 ProtSrcBid: Bid of the SNCP-protected protection source

13 ProtSrcPid: Pid of the SNCP-protected protection source

14 ProtSrcAu4Id: High order PathId of the SNCP-protected protection source

15 ProtSrcTuI: Low order PathId of the SNCP-protected protection source

Output Format

Example :cfg-convert-xctosncp:1,2,3,4,0,3,4,5,0,vc4,10,4,5,6,0

Precautions

Remarks

2.5.18 Convert the SNCP group to the normal service: cfg-convert-sncptoxc

Name cfg-convert-sncptoxc

Function To convert the SNCP group to the normal service.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-convert-sncptoxc:PgId,PuId,XcId
Input Format
Number of parameters: 3

Parameter location Parameter meaning and value

1 PgId: 1-1184
Input Parameters
2 PuId: work or backup

3 XcId: 0-3526 (0 for auto distribution of service ID)

Output Format

Example :cfg-convert-sncptoxc:1,work,0

Precautions

Remarks

2.5.19 Add the SNCP protection packet: cfg-add-sncpbindpg

Name cfg-add-sncpbindpg

Function To add the SNCP protection packet.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 230 of 243

Command Level System operation

Available to User level

Version 5.21.01

Input Format :cfg-add-sncpbindpg:GroupId, GroupType, PgNum, PgId1, PgId2,...

Parameter location Parameter meaning and value

1 GroupId: 1-1184

GroupType: Virtual concatenation group 3 (support the

2
virtualconcatenation group only)
Input Parameters
PgNum: Number of protection groups to be added; value
3
range: 1-1184.

PgId: Id of the protection groups to be added; value range:

4
1-1184.

Output Format

Example :cfg-add-sncpbindpg:1,3,2,1,2

It is required that the protection groups to be added are of the same level, share the same attributes, and are
Precautions
all SNCP-protected and in the ACTIVE status.

Remarks

2.5.20 Query information about the protection group in the SNCP protection packet: cfg-get-
sncpbindpg

Name cfg-get-sncpbindpg

Function To query information about the protection group in the SNCP protection packt.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-sncpbindpg:GroupId
Input Format
Number of parameters: 1; parameter repeated.

Parameter
Parameter meaning and value
location
Input Parameters
1 GroupId: 1-1184

Output Format

Example :cfg-get-sncpbindpg:1

Precautions

Remarks

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 231 of 243

2.5.21 Remove the protection group from the SNCP packet: cfg-remove-sncpbindpg

Name cfg-remove-sncpbindpg

Function To remove the protection group from the SNCP packet.

Command Level System operation

Available to User level

Version 5.21.01

Input Format :cfg-remove-sncpbindpg:GroupId, PgNum, PgId1, PgId2,...

Parameter
Parameter meaning and value
location

1 GroupId: 1-1184
Input Parameters
2 PgNum: Number of the protection groups to be removed; value range: 1-1184.

3 PgId: ID of the protection groups to be removed; value range: 1-1184

Output Format

Example :cfg-remove-sncpbindpg:1,3,2,1,2

Precautions

Remarks

2.6 TPS Protection

2.6.1 Add a TPS protection group: cfg-add-tpspg

Name Cfg-add-tpspg

Function To add a TPS protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-add-tpspg:PgId,WorkBdNum
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 protection group ID: 1~3

Input Parameters
Number of working unit: Determined by the protection type;
2 1~8 for the 2M service, and 1~3 for the 34M, 140M and 155M
services.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 232 of 243

Output Format ¡¡

Example :cfg-add-tpspg:1,5

Precautions The protection group will be valid when the mapping configuration of all the boards is completed.

Remarks

2.6.2 Delete a TPS protection group: cfg-del-tpspg

Name cfg-del-tpspg

Function To delete a TPS protection group.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-del-tpspg:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

Output Format ¡¡

Example :cfg-del-tpspg:1&2

Precautions ¡¡

Remarks The deleting action becomes effective after the verification.

2.6.3 Query all the TPS protection groups: cfg-get-tpspg

Name cfg-get-tpspg

Function To query all the TPS protection groups.

Command Level System monitoring

Available to User level

Version 5.21.01

Input Format :cfg-get-tpspg

Return the following relevant fields in the table format:

PG-ID: Protection group ID
Output Format
WORK-UNIT-NUM: Number of working unit
ACTIVE-FLAG: Current status flag

:cfg-get-tpspg
Example
TPS-PROTECTION-GROUP
PG-ID WORK-UNIT-NUM ACTIVE-FLAG

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 233 of 243

1 5 adding
Total records :1

Precautions ¡¡

Remarks

2.6.4 Set the waiting time for recovery for the TPS protection group: cfg-set-tpswtrtime

Name cfg-set-tpswtrtime

Function To set the waiting time for recovery for the TPS protection group.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tpswtrtime:PgId,WtrTime
Input Format
Number of parameters: 2; parameter blocks repeated.

Parameter location Parameter meaning and value

1 Protection group ID: 1~3

Input Parameters
Waiting time for recovery: 6~720 seconds
2
Default: 600 seconds

Output Format ¡¡

Example :cfg-set-tpswtrtime:1&2,300

Precautions ¡¡

Remarks Configure dynamically the protection group attributes; activating a protection group is taken as modification.

2.6.5 Query the waiting time for recovery of the TPS protection group: cfg-get-tpswtrtime

Name cfg-get-tpswtrtime

Function To query the waiting time for recovery of the TPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpswtrtime:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 234 of 243

PG-ID: Protection group ID

Output Format
WTR-TIME: Waiting time for recovery

:cfg-get-tpswtrtime:1
CFG GET TPS WTRTIME
Example PG-ID WTR-TIME
1 600
Total records :1

Precautions ¡¡

Remarks ¡¡

2.6.6 Set the mapping relationship between the TPS protection unit and the board: cfg-set-
tpsbdmap

Name cfg-set-tpsbdmap

Function To set the mapping relationship between the TPS protection unit and the board.

Command Level System maintenance

Available to User level

Version 5.21.01

:cfg-set-tpsbdmap:PgId,PuId,Bid
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Protection group ID: 1~3

Protection unit ID:

Value Meaning
0 Protection unit board ID
2
1~X Working unit board ID
X is the number of working units specified when creating the
protection.

Input Parameters Board ID:

Service type value
3500:
2M 1~5 and 13~16(Pprotection unit board ID:
specified to 1.)
140M/155M/34M 3~5(Protection unit board ID: 2) or 13~16
3
(Protection unit board ID: 16)
2500:
2M 5~7 and 12~13(Protection unit board ID: 5)
140M/155M/34M 6~7(Protection unit board ID: 6) or 12~13
(Protection unit board ID: 13)

Output Format ¡¡

Example :cfg-set-tpsbdmap:1,0,1

Precautions 1

Not support dynamic configuration; the added protection group become valid when the mapping configuration for
Remarks
all boards is completed.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 235 of 243

2.6.7 Query the mapping relationship between the TPS protection unit and the board: cfg-get-
tpsbdmap

Name cfg-get-tpsbdmap

Function To query the mapping relationship between the TPS protection unit and the board.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpsbdmap:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

PG-ID: Protection group ID

Output Format PU-ID: Protection unit ID
Bid: Board ID

:cfg-get-tpsbdmap:1
TPS-PUMAP
PG-ID PU-ID Bid
1 0 1
1 1 2
1 2 3
Example 1 3 4
1 4 5
1 5 13
1 6 14
1 7 15
1 8 16
Total records :9

Precautions ¡¡

Remarks Report the multiple protection units in various messages.

2.6.8 Set the switchover priority for the TPS protection unit: cfg-set-tpspri

Name cfg-set-tpspri

Function To set the switchover priority for the TPS protection unit.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tpspri:PgId,PuId,Priority
Input Format
Number of parameters: 3; parameter blocks repeated.

Parameter location Parameter meaning and value

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 236 of 243

1 Protection group ID: 1~3

Protection unit ID:

Value Meaning
Input Parameters 2
1~X Working unit
X is the number of working units specified when creating the protection.

3 Switchover priority: 1~X; the highest priority is 1; the default is 1.

Output Format ¡¡

Example :cfg-set-tpspri:1,1,5

Precautions

Remarks Support the dynamic configuration.

2.6.9 Query the switchover priority of the TPS protection unit: cfg-get-tpspri

Name cfg-get-tpspri

Function To query the switchover priority of the TPS protection unit.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpspri:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

PG-ID : Protection group ID

Output Format PU-ID : Protection unit ID
PU-LEVEL: Switchover priority

:cfg-get-tpspri:1
TPS-PU-LEVEL
PG-ID PU-ID PU-LEVEL
1 1 1
1 2 1
1 3 1
Example
1 4 1
1 5 1
1 6 1
1 7 1
1 8 1
Total records :8 ¡¡

Precautions ¡¡

Remarks ¡¡

2.6.10 Initiate the TPS external switchover command: cfg-set-tpsswitch

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 237 of 243

Name cfg-set-tpsswitch

Function To initiate the TPS external switchover command.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-set-tpsswitch:PgId,PuId,ExtCmd
Input Format
Number of parameters: 3; parameters not repetitive.

Parameter location Parameter meaning and value

1 Protection group ID: 1 ~ 3

Protection unit ID:

Value Meaning
2 0 Protecion unit board ID
1~X Working unit board ID
Input Parameters X is the number of working units specified when creating the protection.

Switch command: Value Meaning

tps-lock Lock
tps-unlock Unlock
3 tps-fs Force switchover
tps-cfs Clear the force switchover
tps-ms Manual switchover
tps-cms Clear the manual switchover

Output Format ¡¡

Example :cfg-set-tpsswitch:1,0,tps-lock

The protection unit cannot deliver commands related to the force switchover, clearing the force switchover and the manual
Precautions
switchover.

Remarks The relevant protection group should be in the active status.

2.6.11 Query the switchover status of the TPS protection group: cfg-get-tpsstate

Name cfg-get-tpsstate

Function To query the switchover status of the TPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpsstatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 238 of 243

PG-ID : Protection group ID

Output Format SWITCHED-WORK-UNIT: Switched working unit
SWITCH-STATUS: Switchover status

:cfg-get-tpsstatus:1
TPS-SWITCH-STATUS
Example PG-ID SWITCHED-WORK-UNIT SWITCH-STATUS
1 0 tps-idle
Total records :1

Precautions ¡¡

Remarks ¡¡

2.6.12 Query the locking status of the board inside the TPS protection group: cfg-get-
tpslockstate

Name cfg-get-tpslockstate

Function To query the locking status of the board inside the TPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-tpslockstatus:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

PG-ID: Protection group ID

PU-ID: Protection unit ID
Output Format
BOARD-ID: Board ID
LOCK-STATUS: Locking status

:cfg-get-tpslockstatus:1
TPS-LOCK-STATUS
PG-ID PU-ID BOARD-ID LOCK-STATUS
Example
1 0 1 tps-unlocked
1 1 3 tps-unlocked
Total records :2

Precautions ¡¡

Remarks ¡¡

2.6.13 Start the TPS controller: cfg-start-tps

Name cfg-start-tps

Function To start the TPS controller.

Command Level System operation

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 239 of 243

Available to User level

Version 5.21.01

:cfg-start-tps:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

Output Format ¡¡

Example :cfg-start-tps:1&2

Precautions ¡¡

Remarks The relevant protection group should be in the active status.

2.6.14 Stop the TPS controller: cfg-stop-tps

Name cfg-stop-tps

Function To stop the TPS controller.

Command Level System operation

Available to User level

Version 5.21.01

:cfg-stop-tps:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection group ID: 1~3

Output Format ¡¡

Example :cfg-stop-tps:1&2

Precautions ¡¡

Remarks The relevant protection group should be in the active status.

2.7 DPS Commands

2.7.1 Query information about the DPS protection group: cfg-get-dpspg

Name cfg-get-dpspg

Function To query information about the DPS protection group.

Command Level System monitoring

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 240 of 243

Available to User level

Version 5.21.01

:cfg-get-dpspg:PgId
Input Format
Number of parameters: 1; parameter blocks repeated.

Parameter location Parameter meaning and value

Input Parameters
1 Protection Group ID: 0~2

PG-ID: Protection Group ID

BOARD-NO1:
OSN3500: 9 or 10 (Protection group ID: 1); 17 or 18 (Protection group ID: 2)
OSN2500: 80 or 81 (Protection group ID: 1); 82 or 83 (Protection group ID: 2)
BOARD-NO2:
Output Format
OSN3500: 9 or 10 (Protection group ID: 1); 17 or 18 (Protection group ID: 2)
OSN2500: 80 or 81 (Protection group ID: 1); 82 or 83 (Protection group ID: 2)
PROT-TYPE: Protection type
FUNCTION-TYPE: Function type
ACTIVE-FLAG: adding or deleting or active

:cfg-get-dpspg:1
DPS-PROTECTION-GROUP
Example PG-ID BOARD-NO1 BOARD-NO2 PROT-TYPE FUNCTION-TYPE ACTIVE-FLAG
1 9 10 xcs dps-vc4 active
Total records :1

Precautions ¡¡

The OSN 3500 DPS protection management module supports two protection groups: the XCS active-standby
Remarks protection group and the SCC active-standby protection group. These protection groups are created
automatically by the system, with the ID is respectively 1 and 2. This command supports full-scale query.

2.7.2 Initiate the DPS external switchover command: cfg-set-dpsswitch

Name cfg-set-dpsswitch

Function To initiate the DPS external switchover command.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-set-dpsswitch:PgId,DstBid
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

1 Protection Group ID: 1~2

Input Parameters Destination board ID:

OSN3500: 9 or 10 (Protection group ID: 1); 17 or 18
(Protection group ID: 2)
2
OSN2500: 80 or 81 (Protection group ID: 1); 82 or 83
(Protection group ID: 2)

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 241 of 243

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-dpsswitch: 1,9

Precautions ¡¡

Remarks

2.7.3 Query the switchover status of the DPS protection group: cfg-get-dpsstate

Name cfg-get-dpsstatus

Function To query the switchover status of the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-dpsstatus:PgId
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

Input Parameters
1 Protection Group ID: 1~2

PG-ID: Protection Group ID

Output Format MASTER-BOARD: Current active XCS or SCC board
SLAVE-BOARD: Current standby XCS or SCC board

Example :cfg-get-dpsstatus:1

Precautions ¡¡

Remarks Adopt 0 for the SLAVE-BOARD parameter if the standby XCS or SCC board is not in position.

2.7.4 Set the switchover revert mode for the DPS protection group: cfg-set-dpsrvtmode

Name Cfg-set-dpsrvtmode

Function To set the switchover revert mode for the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-set-dpsrvtmode:PgId,rvtmode,wtrtime
Input Format
Number of parameters: 3

Parameter location Parameter meaning and value

1 Protection Group ID: 1

Input Parameters
Revert mode: rvt - revert mode; norvt ¨C not revert mode
2
Default: norvt

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 242 of 243

Waiting time for recovery: 6~720 (in the rvt mode); 0 (in the
3 norvt mode)
Default: 0; unit: second

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-set-dpsrvtmode:1,rvt,300

Precautions

Remarks Only the XC active-standby protection supports this command.

2.7.5 Query the switchover revert mode of the DPS protection group: cfg-get-dpsrvtmode

Name cfg-get-dpsrvtmode

Function To query the switchover revert mode of the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-dpsrvtmode:PgId
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

Input Parameters
1 PgId: Protection Group ID, 1

:cfg-get-dpsrvtmode:1
DPS-RVT-MODE
Output Format PG-ID RVT-MODE WTR-TIME
1 norvt 0
Total records :1 e

Example :cfg-get-dpsrvtmode:1

Precautions

Remarks Only the XC active-standby protection supports this command.

2.7.6 Query the switching times of the DPS protection group: cfg-get-dpsswitchtimes

Name cfg-get-dpsswitchtimes

Function To query the switching times of the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-get-dpsswitchtimes:PgId
Input Format
Number of parameters: 1

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007

OptiX OSN3500&2500 V100R001 Nesoft Configuration Command Line Reference Page 243 of 243

Parameter location Parameter meaning and value

Input Parameters
1 Protection Group ID: 1~2

:cfg-get-dpsswitchtimes:1
DPS-SWITCH-TIMES
Output Format PG-ID SWITCH-TIMES
1 0
Total records :1

Example :cfg-get-dpsswitchtimes:1

Precautions

Remarks Only the XC active-standby protection supports this command.

2.7.7 Clear the switching times record of the DPS protection group: cfg-clear-dpsswitchtimes

Name cfg-clear-dpsswitchtimes

Function To clear the switching times record of the DPS protection group.

Command Level System monitoring

Available to User level

Version 5.21.01

:cfg-clear-dpsswitchtimes:PgId
Input Format
Number of parameters: 1

Parameter location Parameter meaning and value

Input Parameters
1 PgId: Protection Group ID, 1~2

Output Format Return the ¡°Succeeded!¡± or ¡°Failed!¡± message.

Example :cfg-clear-dpsswitchtimes:1

Precautions

Remarks Only the XC active-standby protection supports this command.

file://D:\CD\Technical Document\trshome\temp\trs_tmp30_24576.htm 9/25/2007