zowe › idms › list › systems🖨️

Lists either all active IDMS systems on an LPAR or lists information about a specific system if a jobname is provided

Usage

zowe idms list systems [options]

IDMS Connection Options

• --host | -H (string)

  • Host name of the IDMS REST API service

• --port | -P (number)

  • Port for the IDMS REST API service

• --user | -u (string)

  • Mainframe user name, which can be the same as your TSO login ID

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

  • Mainframe 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 resources when making REST requests. Only specify this option if you are using an API Mediation Layer

Options

• --jobname | -j (string)

  • The job name of the active IDMS system

• --all | -a (boolean)

  • Lists all active systems. This is the default behavior if no job name is provided

Profile Options

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

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

• Lists all active IDMS systems on the LPAR where the IDMS REST API service is running:

  • zowe idms list systems --all Copy

• Lists a single active IDMS system identified by the IDMS system job name:

  • zowe idms list systems --jobname SYSDEMO Copy