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

List all data sets that match a DSLEVEL pattern (see help below).
The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets:volume, unit, referred, ext, used, recfm, lrecl, blksz, dsorg, and dsname.

Usage

zowe zos-ftp list data-set <pattern> [options]

Positional Arguments

• pattern (string)

  • The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it is somewhat similar to the concept of a 'glob' (but not identical). The following special sequences can be used in the pattern:
    %: Matches any single character
    *: Matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
    **: Matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
    However, the pattern cannot begin with any of these sequences.

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

Options

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

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

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

Response Format Options

• --response-format-filter | --rff (array)

  • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.

• --response-format-type | --rft (string)

  • The command response output format type. Must be one of the following:

    table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

    list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

    object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

    string: Formats output data as a string. JSON objects/arrays are stringified.

    Allowed values: table, list, object, string

• --response-format-header | --rfh (boolean)

  • If "--response-format-type table" is specified, include the column headers in the output.

Examples

• List all data sets beginning with "ibmuser" and ending in "cntl":

  • zowe zos-ftp list data-set "ibmuser.**.cntl" Copy