zowe › zos-files › download › all-members-matching🖨️

Download all members that match a specific pattern from a partitioned data set to a local folder.

Usage

zowe zos-files download all-members-matching <dataSetName> <pattern> [options]

Positional Arguments

• dataSetName (string)

  • The name of the data set from which you want to download members

• pattern (string)

  • The pattern or patterns to match members against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
    %: matches any single character
    *: matches any number of characters within a member
    You can specify multiple patterns separated by commas, for example "Mem*, Test*"

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.

• --directory | -d (string)

  • The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).

• --encoding | --ec (string)

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

• --exclude-patterns | --ep (string)

  • Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.

• --extension | -e (string)

  • Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.

• --fail-fast | --ff (boolean)

  • Set this option to false to continue downloading data set members if one or more fail.

    Default value: true

• --max-concurrent-requests | --mcr (number)

  • Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
    The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.

    Default value: 1

• --preserve-original-letter-case | --po (boolean)

  • Specifies if the automatically generated directories and files use the original letter case.

    Default value: false

• --record | -r (boolean)

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

• --volume-serial | --vs (string)

  • The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.

• --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 members of the data set "ibmuser.loadlib" that begin with "Test" to the directory "loadlib/":

  • zowe zos-files download all-members-matching "ibmuser.loadlib" "Test*" -d loadlib Copy

• Download the members of the data set "ibmuser.cntl" that begin with "Test" & "M" to the directory "output",
  and exclude members that begin with "M2".:

  • zowe zos-files download all-members-matching "ibmuser.cntl" "test*,M*" --exclude-patterns "M2*" -d output Copy