Académique Documents
Professionnel Documents
Culture Documents
CLI
(Command Line Interface)
User Guide
For R3A software series
Table of contents:
INTRODUCTION ........................................................................................................................................ 6
ACCESSING THE ELEMENT .................................................................................................................. 6
VALID USERS ............................................................................................................................................. 6
GETTING STARTED.................................................................................................................................. 7
GETTING HELP ......................................................................................................................................... 9
MODES ......................................................................................................................................................... 9
CHANGING MODES .................................................................................................................................. 9
NON PRIVILEGED USERS ..................................................................................................................... 10
CLI COMMANDS...................................................................................................................................... 11
MODE: USEREXEC................................................................................................................................. 11
clear screen......................................................................................................................................... 11
exit....................................................................................................................................................... 11
help ..................................................................................................................................................... 11
logout .................................................................................................................................................. 11
MODE: EXEC........................................................................................................................................... 12
clear screen......................................................................................................................................... 12
configure terminal............................................................................................................................... 12
end....................................................................................................................................................... 12
exit....................................................................................................................................................... 12
help ..................................................................................................................................................... 12
logout .................................................................................................................................................. 12
reset..................................................................................................................................................... 12
save-config .......................................................................................................................................... 12
setelementip ........................................................................................................................................ 12
show history ........................................................................................................................................ 12
show running-config ........................................................................................................................... 12
clear counters ..................................................................................................................................... 14
clear spanning-tree detected protocols............................................................................................... 14
show [provider-bridge] port config .................................................................................................... 14
show customer spanning-tree.............................................................................................................. 14
show flow-control................................................................................................................................ 14
show interface bridge port-type .......................................................................................................... 14
show interface mtu .............................................................................................................................. 14
show interfaces [{ <interface-type> <interface-id> ] counters ......................................................... 14
show dot1d mac-address-table............................................................................................................ 14
show interfaces ................................................................................................................................... 15
show lldp ............................................................................................................................................. 15
show lldp errors .................................................................................................................................. 15
show lldp interface.............................................................................................................................. 15
show lldp local .................................................................................................................................... 15
show lldp neighbors ............................................................................................................................ 15
show lldp statistics .............................................................................................................................. 15
show lldp traffic .................................................................................................................................. 16
show mac-address-table...................................................................................................................... 16
show mac-address-table aging-time ................................................................................................... 16
show rmon........................................................................................................................................... 16
show users........................................................................................................................................... 16
show vlan ............................................................................................................................................ 16
switchport pvid.................................................................................................................................... 28
spanning-tree link-type ....................................................................................................................... 28
spanning-tree portfast......................................................................................................................... 28
spanning-tree port-priority ................................................................................................................. 28
EXAMPLES OF INTERFACE MODE COMMANDS. ......................................................................... 29
spanning-tree restricted-tcn................................................................................................................ 29
spanning-tree pseudoRootId ............................................................................................................... 29
MODE: VLAN_CONFIG ......................................................................................................................... 30
no ports ............................................................................................................................................... 30
ports .................................................................................................................................................... 30
vlan active ........................................................................................................................................... 30
EXAMPLES OF VLAN MODE COMMANDS. ..................................................................................... 31
Introduction
This guide explains how to use the command line interface (CLI) for XPAND-IP and
contains the list of commands with explanations of each command.
The user guide is for a specific software version, as availability of commands will depend
on the functionality of particular software release.
The valid software version for this user guide is printed on the first page.
The active software version of the element can be found by using the web interface on the
element and choosing the Configuration menu item, then the Software menu item.
The web page that appears will show the active software version on the element.
Valid users
All users of the CLI must be users contained in the elements user database. When a user
tries to log in via the CLI the user is checked by the elements security system. User
parameters like access rights and auto logout time will affect the commands available to
the user and the acceptable inactivity time before logout.
There are only two access rights in the CLI non-privileged or privileged users.
Element security levels of Active, Master or Admin correspond to privileged users of the
CLI all other element security levels correspond to un-privileged users with limited
abilities.
Getting started
The following description is for a Windows XP pc, if you are using another operating
system the general method should be the same but the details may differ.
First check connectivity to make sure your pc and element can talk to each other.
Open a Dos box and issue the command ping <ip-address of element>
See figure 1.
Figure 1
You are now talking with the CLI at the login screen, type a valid user name and
press [ENTER], then the users password and press [ENTER].
A screen similar to that of figure 3 should appear.
Figure 3
Getting Help
At any time you may type the command help to list all commands available with their
parameter list. Typing a command and then help on the same line will give more detailed
help for that particular command. Typing the first few letters of a command and pressing
[TAB] will produce a list of commands beginning with that letter combination.
Modes
A mode is a subset of all commands available.
When you are in a mode the prompt will indicate the mode you are currently in.
Modes available
Mode name
Prompt
assuming privileged
user
EXEC
#
CONFIGURE (config)#
VLAN
(config-vlan)#
INTERFACE (config-if)#
Main purpose
Show commands
Configuring parameters
Configuring vlan ports
Configuring parameters for a particular
interface
When you first log in you will be in EXEC mode, typing help at the prompt will list all
commands available in this mode.
Changing modes
To enter CONFIGURE mode you will need to use the command configure terminal,
notice how the prompt changed from a # to (config)#. To enter INTERFACE mode
you must first be in CONFIGURE mode, the command to enter INTERFACE mode
requires two parameters, the interface-type and interface-id.
Example: interface gigabitethernet 0/1
Hint: Try to enter only the first few characters of each word then press tab
Like this:
in [TAB] gi [TAB] 0/1 notice how the tab expansion works.
When you have entered the INTERFACE mode the prompt will have changed to
(config-if)#
To move back to the previous mode use the exit command, to get back to EXEC mode
directly use the end command.
None
CLI Commands
Mode: USEREXEC
Command
Parameter list
Description
Clears the screen
clear screen
exit
[ command ]
help
logout
Mode: EXEC
Command
Parameter list
Description
Clears the screen
clear screen
Enters configuration mode
configure terminal
Exit from Configure mode
end
exit
[command]
help
logout
Restarts the element
reset
save-config
setelementip
[ip-address subnetMask
gateway]
show history
show running-config
show spanning-tree
Description
Displays detailed spanning
tree information
<interface-type> <interface- Displays Spanning-tree port
id> [{ cost | priority |
configuration
portfast | rootcost |
restricted-role | restrictedNote this command is
tcn | state | stats | detail }]
displayed as two commands
[<interface-type>
when using the help
<interface-id>] layer2command to list all
gateway-port
commands
cost port cost
priority port priority
portfast enabled /
disabled
rootcost root cost
restricted-role enabled
/disabled
restricted-tcn enabled /
disabled
state example Forwarding
stats port statistics
detail detailed port
information
[ interface <interface-type>
<interface-id>]
[ <interface-type> <ifnum>
]
Displays flow-control
information
Shows the Bridge Port Type
of interfaces in the switch
Shows the Maximum
Transmission Unit (MTU)
of interfaces in the switch
Counters for all the
available interfaces
show interfaces [{
<interface-type> <interfaceid> ] counters
show dot1d mac-addresstable
Description
Clears the interface
counters
Restart the protocol
migration process
[address
<aa:aa:aa:aa:aa:aa>]
[{interface <interface-type>
<interface-id>}]
Description
Displays interface status
and configuration
capabilities:
Capabilities of the interface
flowcontrol:
Receive or send flow
control value for an
interface
description:
Description about the
interface
Displays LLDP global
configuration details
Displays the information
about the errors like
memory allocation failures,
queue overflows, table
overflows, etc
show lldp
show lldp errors
[<interface-type>
<interface-id>]
{[<interface-type>
<interface-id>] | [mgmtaddr]}
[chassis-id <string(255)>
port-id <string(255)>]
[<interface-type>
<interface-id>][detail]
Displays LLDP
configuration details on a
particular interface or all
interfaces
Displays the current switch
information that will be
used to populate outbound
LLDP advertisements for a
specific interface or all
interfaces
Displays information about
neighbors learnt on an
interface or all interfaces
Displays the LLDP remote
table statistics
information
show mac-address-table
[vlan <vlan-range>]
[address
<aa:aa:aa:aa:aa:aa>]
[{interface <interface-type>
<interface-id>}]
show mac-address-table
aging-time
show rmon
Description
Displays LLDP counters,
including the no. of frames
sent, received, discarded,
etc
Displays Unicast and
Multicast Mac Address
table
alarms
Configured alarm details
events
Configured event details
history
Configured history details
statistics
Statistics related
information
show users
show vlan
[brief | id <vlan-range> |
summary]
[{port <interface-type>
<interface-id>}]
show spanning-tree
# show spanning-tree
We are the root of the Spanning Tree
Root Id
Priority
32768
Address
00:60:c0:20:08:70
Cost
0
Max Age 20 Sec, Forward Delay 15 Sec
Spanning tree Protocol Enabled.
Bridge is executing the rstp compatible Spanning Tree Protocol
Bridge Id
Priority 32768
Address 00:60:c0:20:08:70
Hello Time 2 sec, Max Age 20 sec, Forward Delay 15 sec
Dynamic Path Cost is Enabled
Name
Role
State
Cost
Prio
Type
---------------------Gi0/1
Designated
Forwarding
200000
128
P2P
State
----Forwarding
Cost
---200000
Prio Type
---- ---128 P2P
Mode: CONFIGURE
Command
Parameter list
Description
Clears the screen
clear screen
Exit from Configure mode
end
exit
[ command ]
help
interface
{<interface-type>
<interface-id>}
no spanning-tree
no spanning-tree priority
no spanning-tree
compatibility
[lag-speed]
no spanning-tree pathcost
dynamic
no spanning-tree transmit
hold-count
no spanning-tree forwardtime
hello-time 2 secs
no spanning-tree hello-time
max-age 20 secs
no spanning-tree max-age
shutdown spanning-tree
<value(0-61440)>
Description
Start spanning tree
operation
Set priority
{stp | rst}
rst
Set mode
[lag-speed]
spanning-tree
spanning-tree priority
spanning-tree compatibility
spanning-tree mode
spanning-tree pathcost
dynamic
<value (1-10)>
spanning-tree transmit holdcount
<seconds(4-30)>
spanning-tree forward-time
<seconds(1-2)>
spanning-tree hello-time
<seconds(6-40)>
spanning-tree max-age
ether-type
Description
Set switch mode
mac-address-table agingtime
no mac-address-table agingtime
spanning-tree provider
no spanning-tree provider
<vlan-id(1-4094)>
vlan
<vlan-id(1-4094)>
no vlan
{on | off}
set cli pagination
no spanning-tree forward-time
(config)# no spanning-tree forward-time
Mode: INTERFACE
Command
Parameter list
Description
Clears the screen
clear screen
Exit from Configure mode
end
exit
[ command ]
help
no shutdown
no spanning-tree
pseudoRootId
priority priority of
pseudo root
mac-address macaddress
id of pseudo root
no spanning-tree auto-edge
no spanning-tree layer2gateway-port
no spanning-tree restrictedrole
no spanning-tree restrictedtcn
Disables automatic
detection of bridge attached
on an interface
withdraws layer two
gateway port status
Disables the root-guard /
restricted role feature on the
port
Disables the topology
change guard/ restricted
TCN feature on the port
Set cost 200000
no spanning-tree cost
no spanning-tree disabled
no spanning-tree link-type
Not in portfast
no spanning-tree portfast
Set port priority to 128
no spanning-tree portpriority
Description
Shutdown interface
shutdown
spanning-tree
spanning-tree auto-edge
{enabled | disabled}
spanning-tree bpdu-receive
spanning-tree layer2gateway-port
spanning-tree restricted-role
spanning-tree restricted-tcn
cost
spanning-tree cost
spanning-tree disable
l2protocol-discard
l2protocol-peer
l2protocol-tunnel
lldp notification
Description
Set port to half or full
duplex
off
Turns off attached devices
or local ports
ability to send packets
on
Allows an interface to send
or receive packets
Discard packets of a
specific protocol
no l2protocol-tunnel
no lldp notification
no lldp tlv-select basic-tlv
{ [port-descr] [sys-name]
[sys-descr] [sys-capab]
[mgmt-addr {all | ipv4
<ucast_addr> }]}
port-descr
Port description TLV
sys-name
System name TLV
sys-descr
System description TLV
sys-capab
System capabilities TLV
mgmt-addr
Configures transmission of
managment
Description
Configure dot1 TLV types
on a port
no speed
no switchport
no switchport acceptable
frame-type
no switchport pvid
set-bridge port-type
{ providerNetworkPort |
customerNetworkPort }
Description
Configure dot1 TLV types
on a port
no lldp
no negotiation
no spanning-tree bpdufilter
no spanning-tree loopguard
spanning-tree
pseudoRootId priority
speed
switchport
switchport acceptableframe-type
Description
Disables or enables BPDU
filtering
Enables loop guard/
restricted forwarding on an
interface
{transmit | receive}
Enables reception and
transmission of LLDPDU
Disables auto-negotiation
on the interface
Disables BPDU filter on the
interface
Disables loop guard/
restricted forwarding on an
interface
<value(0-61440)> macSets the PseudoRoot mac
address <ucast_mac>
address and priority for the
spanning tree only in steps
of 4096
{ 10 | 100 | 1000 }
Set port speed to 10, 100, or
1000 Mbps
To put an interface that is in
Layer 3 mode into Layer 2
mode for Layer 2
configuration
{tagged |
Accept tagged or
untaggedAndPrioritytagged} untaggedAndPrioritytagged
<vlan-id(1-4094)> }
switchport pvid
{point-to-point | shared}
spanning-tree link-type
spanning-tree portfast
<value(0-240)>
spanning-tree port-priority
PVID value to be
configured on the port
The link can be a point-topoint link or can be a shared
LAN segment on which
another bridge is present
Specifies that port has only
hosts connected and hence
can transition to forwarding
rapidly
Set priority
spanning-tree pseudoRootId
(config-if)# spanning-tree pseudoRootId priority 4096 mac-address
00:15:24:00:44:56
Mode: VLAN_CONFIG
Command
no ports
Parameter list
[<interface-type> <0/ab,0/c,...>] [untagged
([<interface-type> <0/ab,0/c,...>] )] [forbidden
([<interface-type> <0/ab,0/c,...>]
[add]
ports
([<interface-type> <0/ab,0/c,...>]) [untagged
(<interface-type> <0/ab,0/c,...>)] [forbidden
<interface-type> <0/ab,0/c,...>]
vlan active
Description
Resets port list for the
VLAN
The above command will add port 2 to the vlan and to the untagged list.
(config-vlan)# ports gigabitethernet 0/3-4
The above command will add port 3 and 4 to the vlan. Note that the add parameter was
ommited, This actually turns the command into a replace command and will remove all
ports not in the list of ports.
To remove ports from a vlan.
(config-vlan)# no ports gigabitethernet 0/3-4
The above command will remove ports 3 and 4 from the vlan.
(config-vlan)# no ports gigabitethernet 0/3,0/7
The above command will remove ports 3 and 7 from the vlan.