zowe › zjcl-expert › remote-fs🖨️

Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.

Usage

zowe zjcl-expert remote-fs <filePath> [options]

Positional Arguments

• filePath (string)

  • The absolute file path of the USS file to be analysed on the remote system.

Options

• --output | -o (string)

  • The output format provided upon completion.

    Default value: json
    Allowed values: json, text

• --alias | -a (string)

  • An alias to give the file name during analysis.

• --dsn-check | -c (string)

  • Turn on or off DSN and USS file existence checking during analysis.

    Default value: ON
    Allowed values: ON, OFF

• --rules | -r (string)

  • The absolute path of the remote rules file used to define user site rules during analysis.

• --job-class | -j (string)

  • The default job class to use during JCL analysis if none is provided.

• --log-level | -l (string)

  • The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.

    Default value: FATAL
    Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL

• --log-file | -d (string)

  • The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.

• --remote-home-dir (string)

  • The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.

• --remote-temp-dir (string)

  • The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.

• --language (string)

  • The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.

    Default value: ENG
    Allowed values: ENG, JPN

• --response-encoding (string)

  • The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.

    Default value: utf-8

Zosmf Connection Options

• --port | -P (number)

  • The z/OSMF server port.

    Default value: 443

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

  • Reject self-signed certificates.

    Default value: true

• --base-path | --bp (string)

  • The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.

• --protocol (string)

  • The protocol used (HTTP or HTTPS)

    Default value: https
    Allowed values: http, https

• --cert-file (local file path)

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

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

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

z/OS Ssh Connection Options

• --ssh-port | -S (number)

  • The z/OS SSH server port.

    Default value: 22

• --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.

Profile Options

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

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

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

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

• --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

• --host | -H (string)

  • Host name of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

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

  • Password to authenticate to service on the mainframe.

• --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.