SSH Commands and Parameters

The following table lists all commands available in SSH. You must be assigned the appropriate privileges in CC-SG to access each command.

Some commands have additional parameters that you must type to execute the command. For more information about how to type commands, see Command Tips.

To list active ports:

activeports

To list active users:

activeusers

To backup a device configuration:

backup device <[-host <host>] | [-id <device_id>]> backup_name [description]

To clear the screen:

clear

To establish a connection to a serial port:

If <port_name> or <device_name> contains spaces, surround the name by quotes.

connect [-d <device_name>] [-e <escape_char>] <[-i <interface_id>] | [-n <port_name>] | [port_id]>

To copy a device configuration from one device to another. SX devices with same number of ports only:

copydevice <[-b <backup_id>] | [source_device_host]> target_device_host

To close port connection:

disconnect <[-u <username>] [-p <port_id>] [-id <connection_id>]>

To enter maintenance mode:

entermaint minutes [message]

To exit maintenance mode:

exitmaint

To search for text from piped output stream:

grep search_term

To view the help screen for all commands:

help

To list available device configuration backups:

listbackups <[-id <device_id>] | [host]>

To list available devices:

listdevices

To list firmware versions available for upgrade:

listfirmwares [[-id <device_id>] | [host]]

To list all interfaces:

listinterfaces [-id <node_id>]

To list all nodes:

listnodes

To list all ports:

listports [[-id <device_id>] | [host]]

To logoff a user:

logoff [-u <username>] message

To list all commands:

ls

To specify paging:

more [-p <page_size>]

To ping a device:

pingdevice <[-id <device_id>] | [host]>

To restart CC-SG:

restartcc minutes [message]

To restart a device:

restartdevice <[-id <device_id>] | [host]>

To restore a device configuration:

restoredevice <[-host <host>] | [-id <device_id>]> [backup_id]

To shutdown CC-SG:

shutdowncc minutes [message]

To open an SSH connection to an SX device:

ssh [-e <escape_char>] <[-id <device_id>] | [host]>

To change a user:

su [-u <user_name>]

To upgrade a device's firmware:

upgradedevice <[-id <device_id>] | [host]>

To list all current users:

userlist

To exit the SSH session:

exit