Node Diagnostic
CLI Commands
Version 3.5.20
260-668242-014
NODE DIAGNOSTIC
Warranty
Aviat Networks makes no representation or warranties with respect to the contents hereof
and specifically disclaims any implied warranties or merchantability or fitness for any
particular purpose.
Further, Aviat Networks reserves the right to revise this publication and to make changes
from time to time in the content hereof without obligation of Aviat Networks to notify any
person of such revision or changes.
Safety Recommendations
The following safety recommendations must be considered to avoid injuries to persons
and/or damage to the equipment:
1. Installation and Service Personnel: Installation and service must be carried out by
authorized personnel who have the technical training and experience necessary to be
aware of any hazardous operations during installation and service, and of measures to
avoid any danger to themselves, to any other personnel, and to the equipment.
2. Access to the Equipment: Access to the equipment in use must be restricted to service
personnel only.
3. Safety Norms: Recommended safety norms are detailed in the Health and Safety
sections of the Eclipse User Manual.
4. Service Personnel Skill: Service personnel must have received adequate technical
training on telecommunications and in particular on the equipment and capabilities this
addendum refers to.
Trademarks
All trademarks are the property of their respective owners.
IV AVIAT NETWORKS
NODE DIAGNOSTIC
Americas Technical Help Desk EMEA Technical Help Desk Asia Pacific Technical Help Desk
Aviat Networks, Inc. Aviat Networks Aviat Networks
San Antonio, TX Blantyre, Glasgow, Scotland Clark Freeport Zone
U.S.A. G72 0FB Philippines 2023
United Kingdom
Phone:+1 210 526 6345 Phone: +1 210 526 6345 Phone: +1 210 526 6345
Toll Free (USA): Fax: Fax: +63 45 599 5196
+1 800 227 8332 +44 16 9871 7204 (English)
Fax:+1 210 526 6315 +33 1 5552 8012 (French)
Email: Email: Email:
CustomerCare.Americas@aviatn CustomerCare.EMEA@aviatnet.co CustomerCare.Asia@aviatnet.co
et.com m m
Or you can contact your local Aviat Networks office. Contact information is available on our
website at: http://www.aviatnetworks.com/services/customer-support/technical-
assistance/
VI AVIAT NETWORKS
NODE DIAGNOSTIC FUNCTIONS CHAPTER 2
System Information
l show system information on page 20
l show running-config on page 16
l show debugging on page 14
Alarms
l alarm on page 9
l alarm severity on page 7
l show alarm type on page 12
l show alarm on page 12
Helpdesk
l helpdesk file on page 9
l helpdesk mode on page 10
Logging
l logging on page 11
l show log on page 15
l show logging on page 15
Remote Access
l ssh on page 20
alarm severity
Command Objective
This command sets the severity level for a given alarm type, when matching instances of
that alarm are in the raised state.
If an Entity ID is specified, the severity level will only be set for the alarm on a specific
component of the system. Otherwise the severity level of all alarms of that type will be set
to the new value (where they do not already have a local setting that differs from the global
setting).
Alarm type IDs and the entities that are monitoring them, may be viewed using the show
alarm and show alarm type commands.
Syntax
alarm <alarm_id> [entity <entity_id>] severity {critical | major |
minor | warning | default}
Parameter Description
alarm_id
The ID of the alarm type.
entity_id
The Entity ID of a component that is monitoring the specified alarm type.
critical
Set the severity of the alarm to critical when raised.
major
Set the severity of the alarm to major when raised.
minor
Set the severity of the alarm to minor when raised.
warning
Set the severity of the alarm to warning when raised.
default
Set the severity of the alarm to its default severity level when raised.
Mode
Global Configuration
Example
The following commands set the severity level to critical, for the alarm type with an ID of 15
on the component with an Entity ID of 503840768.
aos# configure terminal
aos(config)# alarm 15 entity 503840768 severity critical
Related Command(s)
show alarm
Lists the current status of system alarms.
alarm
Command Objective
This command enables or disables (no option) the logging of alarm state changes for a given
alarm type. If an Entity ID (see Entity Commands in Node Administration guide ) is specified,
logging will only be enabled or disabled for the alarm on a specific component of the
system. Otherwise logging will be affected for all system components that are monitoring
the given alarm type. When an alarm type is globally disabled, local settings for instances
of that alarm on individual system components are ignored.
Alarm type IDs and the entities that are monitoring them, may be viewed using the show
alarm and show alarm type commands.
Syntax
alarm <alarm_id> [entity <entity_id>]
no alarm <alarm_id> [entity <entity_id>]
Parameter Description
alarm_id
The ID of the alarm type.
entity_id
The Entity ID of a component that is monitoring the specified alarm type.
Mode
Global Configuration
Example
The following commands prevent state changes being logged, for the alarm type with an ID
of 15 on the component with an Entity ID of 503840768.
aos# configure terminal
aos(config)# no alarm 15 entity 503840768
Related Command(s)
show alarm
Lists the current status of system alarms.
helpdesk file
Command Objective
Syntax
helpdesk file
Command Mode
Privileged EXEC
Example
aos# helpdesk file
Helpdesk file in progress (it may take some time). It must be
downloaded via the GUI reports page.
aos# Helpdesk file completed
helpdesk mode
Command Objective
This command enters the special diagnostic mode.
N O TE: Intended only for Aviat Suppor t per s onnel.
Syntax
helpdesk mode
Mode
Privileged EXEC
locateme
Command Objective
This command enables the locateme process.
The no option disables the locateme process.
N O TE: The r ac k loc ation tool c ommand is for CTR 8540, does not apply to
CTR 8300.
Syntax
locateme
no locateme
Mode
Privileged EXEC
Default
Example
aos# locateme
aos# no locateme
logging
Command Objective
This command enables syslog logging to a remote host.
The no option disables syslog logging to a remote host.
Syntax
logging <remote_host_ip> [port <port_num>] [protocol <protocol_
type>] [security]
no logging <remote_host_ip>
Parameter Description
remote_host_ip
The IP address of the remote syslog host
port_num
The port to be used for remote logging (default is 514).
protocol_type
The transport protocol; TCP or UDP (default is UDP).
security
Include secure (privileged) messages in log.
Mode
Global Configuration
Examples
aos# configure terminal
aos(config)# logging 192.168.1.10
Syntax
show alarm type [id <alarm_id>]
Parameter Description
alarm_id
The ID of the alarm type.
Mode
User EXEC / Privileged EXEC
Example
aos# show alarm type id 1
Alarm ID = 1
===============
Description: Secondary power failure
Security Alarm: no
ITU Event Type: 5 - equipment alarm
Default Severity: 4 - major
Configured Severity: 4 - major
Alarm Enabled: yes
show alarm
Command Objective
This command lists the current status of system alarms.
N O TE: Sec ur ity alar ms w ill only be s how n in the output for us er s w ith
s uffic ient pr ivileges .
Syntax
show alarm [all] [brief] [id <alarm_id>] [entity <entity_id>]
Parameter Description
all
Includes alarm instances in the output that are currently in the cleared state, are
suspended, or are disabled by configuration.
brief
Provides a status summary in tabularised form.
alarm_id
The ID of the alarm type, used to filter the output.
entity_id
The Entity ID of the component that is monitoring the specified alarm type, used to
filter the output.
Mode
User EXEC / Privileged EXEC
Examples
To show all system alarms that are currently raised:
aos# show alarm Entity ID = 504365056 (gigabitethernet 1/0/1)
=============================================
Alarm ID = 16
Description: Ethernet port link down - Loss of signal on
interface.
ITU Event Type: 2 - communications alarm
Current Severity: 4 - major
Probable Cause: 8 - loss of signal
Last Status Change: 2014-3-02, 17:11:54.7
Status Change Count: 1
To show all alarms that are being monitored by the component with an Entity ID of
301989888:
aos# show alarm all entity 301989888
Entity ID = 301989888 (slot 1/1)
================================
Alarm ID = 5
Description: Module is not supported
ITU Event Type: 5 - equipment alarm
Current Severity: 1 - cleared
Probable Cause: N/A
Last Status Change: 2014-3-02, 17:11:18.2
Status Change Count: 0
Suspended no
Configured Severity: 6 - warning
Alarm Enabled: yes
Alarm ID = 17
Description: Module is missing
ITU Event Type: 5 - equipment alarm
Current Severity: 1 - cleared
Probable Cause: N/A
Last Status Change: 2014-3-02, 17:11:18.2
Status Change Count: 0
Suspended: no
Configured Severity: 4 - major
Alarm Enabled: yes
To show a brief tabularised account of all alarms being monitored by the component with an
Entity ID of 301989888:
aos# show alarm all brief entity 301989888
Entity-ID Alarm-ID Event-Type Cur-Sev Prob-Cause Change-Cnt Susp
Cfg-Sev Ena
================================================================
==============
301989888 0005 05 CLEAR N/A 0000000000 no
WARN yes
301989888 0017 05 CLEAR N/A 0000000000 no
MAJOR yes
show debugging
Command Objective
This command displays state of each debugging option.
Syntax
show debugging
Mode
Privileged EXEC Mode
Example
aos# show debugging
Spanning Tree :
Spanning tree timers related debugging is on
Related Commands
debug spanning-tree
Provides spanning tree debugging support
debug ssh
Sets the given trace levels for SSH
debug ssl
Sets the given debug levels for SSL
debug vlan
Enables the tracing of the VLAN submodule as per the configured debug levels.
debug ethernet-oam
Enables/displays the debug level for the EOAM Module
show log
Command Objective
This command shows the current syslog contents.
Syntax
show log
Mode
User EXEC / Privileged EXEC
Example
aos# show log
2012 Nov 2 10:30:35.250 user.info ctr8540 AOS: (CLI) User root
logged in via c onsole
2012 Nov 2 10:30:35.250 user.alert ctr8540 AOS: (CLI) Attempt to
login as root via console Succeeded
2012 Nov 2 10:30:32.720 user.info ctr8540 AOS: (CFA) Slot0/6
Link Status [UP]
2012 Nov 2 10:30:31.330 user.info ctr8540 AOS: (MSR) Restored
configuration from flash successfully!
2012 Nov 2 10:30:29.930 user.info ctr8540 AOS: (CFA) Slot0/8
Link Status [DOWN ]
2012 Nov 2 10:30:29.930 user.info ctr8540 AOS: (CFA) Slot0/7
Link Status [DOWN ]
2012 Nov 2 10:30:29.930 user.info ctr8540 AOS: (CFA) Slot0/6
Link Status [DOWN ]
2012 Nov 2 10:30:29.930 user.info ctr8540 AOS: (CFA) Slot0/5
Link Status [DOWN ]
2012 Nov 2 10:30:29.930 user.info ctr8540 AOS: (CFA) Slot0/4
Link Status [DOWN ]
2012 Nov 2 10:30:29.820 user.info ctr8540 AOS: (CFA) Slot0/3
Link Status [DOWN ]
2012 Nov 2 10:30:29.820 user.info ctr8540 AOS: (CFA) Slot0/2
Link Status [DOWN ]
2012 Nov 2 10:30:29.820 user.info ctr8540 AOS: (CFA) Slot0/3
Link Status [DOWN ]
2012 Nov 2 10:30:29.820 user.info ctr8540 AOS: (CFA) Slot0/2
Link Status [DOWN ]
2012 Nov 2 10:30:29.820 user.info ctr8540 AOS: (CFA) Slot0/1
Link Status [DOWN ]
show logging
Command Objective
This command shows the list of remote syslog hosts.
Syntax
show logging
Mode
Example
aos# show logging
Address Port Protocol Level
------------------------------------------
192.168.1.20 514 UDP Normal
10.200.12.50 2082 TCP Security
show running-config
This command displays the configuration information currently running on the router, the
configuration for a specific interface, or map class information and this configuration is lost
if the system is restarted. The command is useful when there are multiple interfaces and
you want to look at the configuration of a specific interface.
N O TE: If exec uted w ithout the optional par ameter s this c ommand
dis plays the c ur r ent ac tive c onfigur ations , other than the default
c onfigur ations of all the modules in all the inter fac es .
Syntax
show running-config [{ syslog | | stp [ switch <context_name> ] |
ecfm [switch <context_name>] | vlan <vlan-id(1-4094)> [ switch
<context_name> ] | interface { port-channel <port-channel-id(1-
65535)> | <interfacetype> <interfacenum> | vlan <vlan-id(1-4094)>
} | ssh | ssl | ip | snmp | rmon | rm | eoam | fm | elmi | route-
map | qosxtd | tac | sntp | switch <context_name> | erps | [switch
<context_name>] | entity-mib | http | |cn [switch <context_name>]
| dcbx | clkiwf | }]
Parameter Descrip[tion
syslog
Displays the configuration done in the syslog module
stp
Displays the configuration done in the STP module
switch <context_name>
Displays the configuration done in the context for the specified module. This value
represents unique name of the switch context. This value is a string whose maximum
size is 32.
This parameter is specific to multiple instance feature.
ecfm
Displays the configuration done in the ECFM module.
vlan<vlan-id(1-4094)>
Displays the configuration done for the specified VLAN ID. This is a unique value that
represents the specific VLAN created.
This value ranges between 1 and 4094.
port-channel <port-channel-id(1-65535)>
Displays the configuration done for the specified port channel ID. This is a unique
value that represents the specific port channel created.
This value ranges between 1 and 65535.
<interfacetype>
Displays the configuration done for the specified type of interface. The interface can
be:
Fastethernet
Officially referred to as 100BASE-T standard. This is a version of LAN standard
architecture that supports data transfer upto 100 Megabits per second.
Gigabitethernet
A version of LAN standard architecture that supports data transfer upto 1
Gigabit per second.
extreme-ethernet
A version of Ethernet that supports data transfer upto 10 Gigabits per second.
This Ethernet supports only full duplex links.
internal-lan
Internal LAN created on a bridge per IEEE 802.1ap.
<interfacenum>
Displays the configuration done for the specified interface identifier. This is a unique
value that represents the specific interface.
This value is a combination of slot number and port number separated by a slash, for
interface type other than i-lan.
For example: 0/1 represents that the slot number is 0 and port number is 1.
Only i-lan ID is provided, for interface type i-lan. For example: 1 represents i-lan ID.
ssh
Displays the configuration done in the SSH module
ssl
Displays the configuration done in the SSL module
ip
Displays the configuration done in the IP module
snmp
Displays the configuration done in the SNMP module
rmon
Displays the configuration done in the RMON module
rm
Displays the configuration done in the RM module
eoam
Displays the configuration done in the EOAM module
fm
Displays the configuration done in the FM module
route-map
Displays the configuration done for the route map feature
qosxtd
Displays the configuration done in the extended QoS module
tac
Displays the configuration done in the TAC module
sntp
Displays the configuration done in the SNTP module
switch <context_name>
Displays the configuration done in the context for the specified module. This value
represents unique name of the switch context. This value is a string whose maximum
size is 32.
This parameter is specific to multiple instance feature.
erps
Displays the configuration done in the ERPS module
switch <context_name>
Displays the configuration done in the context for the specified module. This value
represents unique name of the switch context. This value is a string whose maximum
size is 32.
This parameter is specific to multiple instance feature.
entity-mib
Displays the configuration done in the emtity-mib module
http
Displays the configuration done in the http module
switch <context_name>
Displays the configuration done in the context for the specified module. This value
represents unique name of the switch context. This value is a string whose maximum
size is 32.
This parameter is specific to multiple instance feature.
clkiwf
Displays the configuration done in the clkiwf module
Mode
Privileged EXEC Mode
Example
The output given below is only a fragment of the whole output. This output differs based on
the modules that are configured.
aos# sh running-config stp
#Building configuration...
switch default
!
switch default
!
switch default
spanning-tree mst configuration
name 00:e0:e2:6f:a5:b1
!
!
interface gigabitethernet 0/1
!
interface gigabitethernet 0/2
!
interface gigabitethernet 0/3
!
interface gigabitethernet 0/4
!
interface gigabitethernet 0/5
!
interface gigabitethernet 0/6
!
interface gigabitethernet 0/7
!
interface gigabitethernet 0/8
!
interface gigabitethernet 0/9
!
interface gigabitethernet 0/10
!
interface gigabitethernet 0/11
!
interface gigabitethernet 0/12
!
interface prot 1
!
switch default
!
end
Related Commands
Related commands include the configuration commands of all the modules (given as
parameters in the show running-config command).
Syntax
show system information
Mode
Privileged EXEC Mode
Example
aos# show system information
Hardware Version : 012
Firmware Version : 1.6.123
Software Version : 2.2.0(12.1761)
Switch Name : CTR8540
System Contact : sales@aviatnet.com
System Location : Unknown
Login Authentication Mode : Local
Config Restore Status : Successful
Related Commands
write
Writes the running-config to a file in flash, startup-configuration file or to a
remote site.
erase
Clears the contents of the startup configuration to default values.
system contact
Sets the system contact information.
system location
Sets the system location.
ssh
Command Objective
This command starts an SSH session between the CTR and the device at the destination IP
using the given login.
Syntax
ssh <username> <destination-ip>
Parameter Description
username
ip address
An IPv4 or IPv6 address.
Mode
User EXEC / Privileged EXEC
Example
aos# ssh root 12.0.0.1
Aviat Networks Converged Transport Router
root@12.0.0.1's password: