zowe › zos-files › download › uss-file🖨️

Download content from a USS file to a local file on your PC.

Usage

zowe zos-files download uss-file <ussFileName> [options]

Positional Arguments

• ussFileName (string)

  • The name of the USS file you want to download

Options

• --attributes | --attrs (local file path)

  • Path of an attributes file to control how files are downloaded.

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

• --encoding | --ec (string)

  • Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.

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

• --response-timeout | --rto (number)

  • The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600

Zosmf Connection Options

• --host | -H (string)

  • The z/OSMF server host name.

• --port | -P (number)

  • The z/OSMF server port.

    Default value: 443

• --user | -u (string)

  • Mainframe (z/OSMF) user name, which can be the same as your TSO login.

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

  • Mainframe (z/OSMF) password, which can be the same as your TSO password.

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

Profile Options

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

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

Examples

• Download the file "/a/ibmuser/my_text.txt" to ./my_text.txt:

  • zowe zos-files download uss-file "/a/ibmuser/my_text.txt" -f ./my_text.txt Copy

• Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" in binary mode:

  • zowe zos-files download uss-file "/a/ibmuser/MyJava.class" -b -f "java/MyJava.class" Copy

• Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" using a .zosattributes file:

  • zowe zos-files download uss-file "/a/ibmuser/MyJava.class" --attributes /path/to/.zosattributes -f "java/MyJava.class" Copy