zowe › idms › list › log🖨️

Lists log messages based on the search options provided

Usage

zowe idms list log [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

• --datasource | -d (string)

  • Identifies the CA IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API

Required Options

• --start-time | --st (string)

  • Start time of the first log message

    Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

• --end-time | --et (string)

  • End time of the last log message

    Format: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]'

Options

• --record-type | --rt (string)

  • Type of log records:

    1 - #WTL text line

    2 - User trace text or physical I/O trace text

    3 - User binary trace entries

    4 - Snap or dump text

    5 - Snap or dump binary entries

    Examples: '1,2', '1,4,5', '2'

• --record-identifier | --ri (string)

  • Identifier contained in log messages

    Examples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'

• --search-text | --stext (string)

  • Text contained in log messages

    Examples: 'DB001108', 'any_text_that_might_exist_in_the_message'

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 the log messages where the time stamps satisfy the start and end time criteria:

  • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00" Copy

• Lists all the #WTL log messages where 'DB001108' is contained in the log message and where the time stamps satisfy the start and end time criteria:

  • zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00" --record-type 1 --search-text DB001108 Copy

• Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria:

  • zowe idms list log --start-time "2020-08-05 08:00:00.001234" --end-time "2020-08-05 13:43:33.26" --record-identifier DCSYSTEM Copy