zowe › zos-ftp › download › data-set🖨️

Download the contents of a z/OS data set to a local file

Usage

zowe zos-ftp download data-set <dataSet> [options]

Positional Arguments

• dataSet (string)

  • The data set (PDS member or physical sequential data set) which you would like to download to a local file.

Options

• --binary | -b (boolean)

  • Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.

• --file | -f (string)

  • The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.

• --record | -r | --rdw (boolean)

  • Download the variable-length data set with RECFM of V, VB, VBS, etc in rdw mode, in which the 4-byte RDW (Record Descriptor Word) is inserted at the begining of each record.

• --encoding | --ec (string)

  • The encoding for download and upload of z/OS data set.

FTP Connection options

• --host | -H (string)

  • The hostname or IP address of the z/OS server to connect to.

• --port | -P (number)

  • The port of the z/OS FTP server.

    Default value: 21

• --user | -u (string)

  • Username for authentication on z/OS

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

  • Password to authenticate to FTP.

• --secure-ftp (boolean)

  • Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.

    Default value: true

• --connection-timeout | --ct (number)

  • How long (in milliseconds) to wait for the control connection to be established.

    Default value: 10000

TLS / Secure Connection options

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

  • Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.

• --server-name | --sn (string)

  • Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely

Profile Options

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

  • The name of a (zftp) 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

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

Examples

• Download the data set "ibmuser.loadlib(main)" in binary mode to the local file "main.obj":

  • zowe zos-ftp download data-set "ibmuser.loadlib(main)" -b -f main.obj Copy