ssh2

ssh2 {cipher cipher} {mac mac} {port portnum} {compression [on | off]} {user username} {username} [host | ipaddress] {remote command } {vr vr_name}

Description

Initiates an SSH2 client session to a remote SSH2 server.

Syntax Description

cipher Specifies the name of the cipher.
Possible values are:
  • aes128-cbc

  • aes128-ctr

  • aes192-cbc

  • aes192-ctr

  • aes256-cbc

  • aes256-ctr

  • arcfour

  • arcfour128

  • arcfour256

  • cast128-cbc

  • chacha20-poly1305@openssh.com

  • rijndael-cbc@lysator.liu.se

mac Specifies the name of the Message Authentication Code.
Possible values are:
  • hmac-md5

  • hmac-md5-96

  • hmac-md5-96-etm@openssh.com

  • hmac-md5-etm@openssh.com

  • hmac-ripemd160

  • hmac-ripemd160@openssh.com

  • hmac-ripemd160-etm@openssh.com

  • hmac-sha1

  • hmac-sha1-96

  • hmac-sha1-96-etm@openssh.com

  • hmac-sha1-etm@openssh.com

  • hmac-sha2-256

  • hmac-sha2-256-etm@openssh.com

  • hmac-sha2-512

  • hmac-sha2-512-etm@openssh.com

portnum Specifies the TCP port number to be used for communicating with the SSH2 client. The default is port 22.
on Specifies that the data is to be compressed.
off Specifies that compression is not to be used. This is the default.
username Specifies a login name for the remote host, as an alternate to the username@host parameter. Can be omitted if it is the same as the username on the switch.
host Specifies the name of the remote host.
ipaddress Specifies the IP address of the remote host.
remote command Specifies a command to be passed to the remote system for execution. The switch does not support remote commands. The option is only valid if the remote system is a system, such as a UNIX workstation, that accepts remote commands.
vr_name Specifies the virtual router. The default virtual router is VR-Mgmt.
Note: User-created VRs are supported only on the platforms listed for this feature in the Feature License Requirements document.

Default

The default settings for SSH2 parameters are as follows:
  • cipher—the full cipher list
  • mac—the full Message Authentication Code list
  • port—22
  • compression—off
  • vr_name—VR-Mgmt

Usage Guidelines

SSH2 does not need to be enabled on the switch in order to use this command.

Typically, this command is used to establish a secure session to a remote switch. You are prompted for your password. Once you have logged in successfully, all ExtremeXOS command you enter are executed on the remote switch. When you terminate the remote session, commands will then resume being executed on the original switch.

Host Name, User Name, and Remote IP Address Character Restrictions

This section provides information about the characters supported by the switch for host names and remote IP addresses.

When specifying a host name, user name, or remote IP address, the switch permits only the following characters:
  • Alphabetical letters, upper case and lower case (A-Z, a-z)
  • Numerals (0-9)
  • Period ( . )
  • Dash ( - ) Permitted for host and user names
  • Underscore ( _ ) Permitted for host and user names
  • Colon ( : ) Permitted for host names and remote IP addresses
  • At symbol ( @ ) Permitted only for user names

When naming the host, creating a user name, or configuring the IP address, remember the requirements listed above.

Remote Filename Character Restrictions

This section provides information about the characters supported by the switch for remote filenames.

When specifying a remote filename, the switch permits only the following characters:
  • Alphabetical letters, upper case and lower case (A-Z, a-z)
  • Numerals (0-9)
  • Period ( . )
  • Dash ( - )
  • Underscore ( _ )
  • Slash ( / )

When naming a remote file, remember the requirements listed above.

Example

The following example establishes an SSH2 session on switch engineering1:

ssh2 admin@engineering1

The following example establishes an SSH2 session with the switch named BlackDiamond8810 over TCP port 2050 with compression enabled:

ssh2 compression on port 2050 admin@BlackDiamond8810

History

This command was first available in ExtremeXOS 11.2.

Changes to cipher, as well as the addition of mac, were first available in ExtremeXOS 15.7.1.

Platform Availability

This command is available on all platforms with the SSH2 module installed.