zowe › zos-ssh › issue › command🖨️

Issue a z/OS USS command

Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.

Usage

zowe zos-ssh issue command <command> [options]

Positional Arguments

• command (string)

  • z/OS USS command to issue.

Options

• --cwd (string)

  • Working directory in which to execute the command.

• --exec | -e (boolean)

  • Use exec channel instead of interactive shell. Faster but does not load ~/.profile or ~/.bashrc.

    Default value: false

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.

• --host-key | --hk (string)

  • The trusted host key of the z/OS SSH server, as the base64-encoded key blob presented by the server. When set, the server's key is verified against it before any credentials are sent.

• --insecure | -i (boolean)

  • Skip verification of the z/OS SSH server's host key, so the server's identity is not confirmed before credentials are sent.

    Default value: false

Profile Options

• --ssh-profile | --ssh-p (string)

  • The name of a (ssh) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

• --cert-account (string)

  • The account name for PKCS 12 certificate stored in credential manager

Examples

• Issue a simple command, giving the working directory:

  • zowe zos-ssh issue command "npm install express" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp Copy

• Issue a command using exec mode (faster, does not load profile files):

  • zowe zos-ssh issue command "ls -la" --exec Copy

• Issue a command in exec mode with working directory:

  • zowe zos-ssh issue command "pwd" --cwd /u/myuser/project --exec Copy