zowe › profiles › create › ssh-profile🖨️

z/OS SSH Profile

Usage

zowe profiles create ssh-profile <profileName> [options]

Positional Arguments

• profileName (string)

  • Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.

z/OS Ssh Connection Options

• --host | -H (string)

  • The z/OS SSH server host name.

• --port | -P (number)

  • The z/OS SSH server port.

    Default value: 22

• --user | -u (string)

  • Mainframe user name, which can be the same as your TSO login.

• --password | --pass | --pw (string)

  • Mainframe password, which can be the same as your TSO password.

• --privateKey | --key | --pk (string)

  • Path to a file containing your private key, that must match a public key stored in the server for authentication

• --keyPassphrase | --passphrase | --kp (string)

  • Private key passphrase, which unlocks the private key.

• --handshakeTimeout | --timeout | --to (number)

  • How long in milliseconds to wait for the SSH handshake to complete.

Options

• --overwrite | --ow (boolean)

  • Overwrite the ssh profile when a profile of the same name exists.

• --disable-defaults | --dd (boolean)

  • Disable populating profile values of undefined properties with default values.

Examples

• Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22:

  • zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss Copy

• Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022:

  • zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss Copy

• Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' for privatekey authentication:

  • zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase Copy

• Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying username, host, or password, preventing those values from being stored on disk:

  • zowe profiles create ssh-profile ssh444 --privateKey /path/to/privatekey Copy