zowe › cics › get › resource🖨️

Get resources (for example, programs or transactions) from CICS.

Usage

zowe cics get resource <resourceName> [options]

Positional Arguments

• resourceName (string)

  • The name of the resource to get.

Options

• --region-name | --rn (string)

  • The CICS region name from which to get the resources

• --cics-plex | --cp (string)

  • The name of the CICSPlex from which to get the resources

• --criteria | -c (string)

  • The criteria by which to filter the resource

• --parameter | -p (string)

  • The parameter by which to refine the resource

Cics Connection Options

• --host | -H (string)

  • The CICS server host name.

• --port | -P (number)

  • The CICS server port.

    Default value: 443

• --user | -u (string)

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

• --password | --pw (string)

  • Mainframe (CICS) password, which can be the same as your TSO password.

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

  • Reject self-signed certificates.

    Default value: true

• --protocol | -o (string)

  • Specifies CMCI protocol (http or https).

    Default value: https
    Allowed values: http, https

Profile Options

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

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

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

• Get program resources from the region named MYREGION:

  • zowe cics get resource CICSProgram --region-name MYREGION Copy

• Get local transaction resources from the region named MYREGION:

  • zowe cics get resource CICSLocalTransaction --region-name MYREGION Copy

• Get local file resources from the region named MYREGION:

  • zowe cics get resource CICSLocalFile --region-name MYREGION Copy

• Get program definition resources from the CSD group named GRP1 and the region named MYREGION:

  • zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)" Copy

• Get transaction definition resources from the CSD group named GRP1 and the region named MYREGION:

  • zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)" Copy

• Get URIMap definition resources from the CSD group named GRP1 and the region named MYREGION:

  • zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)" Copy

• Get program resources that start with the name PRG from the region named MYREGION:

  • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*" Copy

• Get a local transaction resource named TRAN from the region named MYREGION:

  • zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN" Copy

• Get program resources that start with the name MYPRG from the region named MYREGION and display various fields as a table:

  • zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status Copy