zowe › zos-workflows › list › definition-file-details🖨️

Retrieve the contents of a z/OSMF workflow definition from a z/OS system.

Usage

zowe zos-workflows list definition-file-details <definitionFilePath> [options]

Positional Arguments

• definitionFilePath (string)

  • Specifies the location of the workflow definition file, which is either a UNIX path name or a fully qualified z/OS data set name.

Options

• --list-steps | --ls (boolean)

  • Optional parameter for listing steps and their properties.

• --list-variables | --lv (boolean)

  • Optional parameter for listing variables and their properties.

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

• --completion-timeout | --cto (number)

  • The amount in time, in seconds, a REST operation should wait to complete before timing out

• --establish-connection-timeout | --ecto (number)

  • The amount of time, in seconds, a REST operation should wait while connecting to the server before timing out

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

• To list the contents of a workflow definition stored in the UNIX file "/user/dir/workflow.xml" including its steps and variables:

  • zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables Copy

• To list the contents of a workflow definition stored in the z/OS data set "USER.DATA.SET.XML" including its steps and variables:

  • zowe zos-workflows list definition-file-details "USER.DATA.SET.XML" --list-steps --list-variables Copy