Syntax
CLI for line test supports two commands:
• «getlastresult» retrieves the results of the most recently executed line test of a specific SUBH<X>, SUPC<X>, or SUPM<X> port or the near and far end noise margins of DSL units.
• «execute» triggers an immediate line test on a specific SUBH<X> unit and then retrieves the measurement values for the specified criteria.
The commands have the following format:
oam linetest asynch <msgId> <type> <command> <criteria> <address>
<msgId> | msgId (message identity) is an integer provided by the client. The server does not interpret it; it simply returns it in its response. |
<type> | Two types are available: pots | dsl |
<command> | Two commands are available: getlastresult | execute «execute» is only possible together with the type «pots». |
<criteria> | all or a single one of the available criteria can be specified: all | isolation | foreign_voltage | capacity | noise_ratio Only the criteria activated in the configuration of the unit can be retrieved. For the type «dsl» the entry in «criteria» has no meaning, but must be specified. |
<address> | POTS, FOX51x: An active subunit of a SUBH<X> unit must be specified. /<NE IP address>/<slot>/<subunit> POTS, FOX61x: An active port of a SUPMx unit must be specified. /<NE IP address>/unit-<x>/port-<y> VoIP, FOX61x: An active Termination ID/subscriber# must be specified: COSI1: /gwIPAddr-<GW IP address>/subsNo-<subscriber#> POTS, FOX61x: An active port of a LESU1 unit must be specified. /<NE IP address>/unit-<x>/port-<y> VoIP, FOX61x: An active Termination ID/subscriber# must be specified: COSI1: /gwIPAddr-<GW IP address>/subsNo-<subscriber#> DSL: An active subunit of a DSL unit must be specified. /<NE IP address>/<slot>/<subunit> |
Examples for FOX51x units:
oam linetest asynch 1 pots getlastresult all /192.168.21.21/8/1
oam linetest asynch 1 pots execute all /192.168.21.21/8/1
oam linetest asynch 1 dsl getlastresult all /192.168.21.21/12/1
Examples for FOX61x units:
oam linetest asynch 1 pots getlastresult all /192.168.24.31/unit-6/port-1
oam linetest asynch 1 pots execute all /192.168.24.31/ unit-6/port-1
The syntax for the immediate answer to a request using correct syntax is as follows:
oam linetestResponse asynch <msgId> [<errorcode>] [<optional error text>]
If the immediate response does not contain an error indication, it will be followed by a time stamp and the requested line test data.
The command to terminate a CLI session is:
quit
Below are two sample sessions using the «telnet» command. The socket number is taken from the entry in the nbcli.conf file. Grey background is used to indicate the data transmitted from the TCP client to the server. Responses from the server have no background.
POTS line test for a FOX51x POTS unit:
$ telnet localhost $(${NEM_HOME}/bin/private/getvar nbi_clilinetest_oss_port)
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
NEM linetest_cli northbound interface
Login: ^Cusername
Password: ^Cpassword
Logged
oam linetest asynch 1 pots getlastresult all /192.168.21.21/8/1
oam linetestResponse asynch 1
timestamp:1163894444
status:Passed
Resistance a-b,Passed,> 800 [kOhm]
Isolation a-GND,Passed,> 200 [kOhm]
Isolation b-GND,Passed,> 200 [kOhm]
Foreign DC Voltage a-b,Passed,0 [V]
Foreign DC Voltage a-GND,Passed,1 [V]
Foreign DC Voltage b-GND,Passed,0 [V]
Foreign AC Voltage a-b,Passed,0 [V]
Foreign AC Voltage a-GND,Passed,0 [V]
Foreign AC Voltage b-GND,Passed,0 [V]
Capacitance a-b,Passed,0.00 [µF]
Capacitance a-GND,Passed,0.03 [µF]
Capacitance b-GND,Passed,0.03 [µF]
Noise,Passed,< -40 [dBm]
ok
DSL line test for a FOX51x DSL unit:
$ telnet localhost $(${NEM_HOME}/bin/private/getvar nbi_clilinetest_oss_port)
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
NEM linetest_cli northbound interface
Login: ^Cusername
Password: ^Cpassword
Logged
oam linetest asynch 1 dsl getlastresult all /192.168.21.21/12/1
oam linetestResponse asynch 1
timestamp:1163894721
status:Passed
Noise Margin Near,Passed,14 [dB]
Noise Margin Far,Passed,11 [dB]
ok