list_log – Lists log messages

Synopsis

Lists log messages based on the search options provided.

Parameters

host (type: str)

Host name of the IDMS REST API service.

port (type: int)

Port for the IDMS REST API service.

user (type: str)

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

password (type: str)

Mainframe password, which can be the same as your TSO password.

reject_unauthorized (type: bool, default: True)

Reject self-signed certificates.

base_path (type: str)

The base path for your Zowe 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 Zowe API Mediation Layer.

datasource (type: str)

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

start_time (required, type: str)

Start time of the first log message

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

end_time (required, type: str)

End time of the last log message

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

record_type (type: str)

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 (type: str)

Identifier contained in log messages

Examples: ‘LTE0001,LTVTM011’, ‘DCSYSTEM’, ‘SYSTE160’.

search_text (type: str)

Text contained in log messages

Examples: ‘DB001108’, ‘any_text_that_might_exist_in_the_message’.

cert_file (type: 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 (type: path)

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

response_format_filter (type: list)

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 (type: str)

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.

Choices:

  • table

  • list

  • object

  • string

response_format_header (type: bool)

If “–response-format-type table” is specified, include the column headers in the output.

Examples

- name: Lists all the log messages where the time stamps satisfy the start and end time criteria
  broadcom.idms.list_log:
    start_time: 2020-08-05 09:20:00
    end_time: 2020-08-05 10:20:00

- name: 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
  broadcom.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

- name: Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria
  broadcom.idms.list_log:
    start_time: 2020-08-05 08:00:00.001234
    end_time: 2020-08-05 13:43:33.26
    record_identifier: DCSYSTEM

Return Values

data (type: list, when returned data is a dictionary)

Data from the module execution (a data structure). The items of this dict are set as individual return values on the top level as well.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.