/ home / ibm / ibm.ibm_zos_core / 1.9.0 / module / zos_operator_action_query

ibm.ibm_zos_core.zos_operator_action_query (1.9.0) — module

Display messages requiring action

| "added in version" 1.1.0 of ibm.ibm_zos_core"

Authors: Ping Xiao (@xiaoping8385), Demetrios Dimatos (@ddimatos), Ivan Moreno (@rexemin), Rich Parker (@richp405)

Install collection

Install with ansible-galaxy collection install ibm.ibm_zos_core:==1.9.0

Add to requirements.yml

  collections:
    - name: ibm.ibm_zos_core
      version: 1.9.0

Description

Get a list of outstanding messages requiring operator action given one or more conditions.

Usage examples

Scanned by Steampunk Spotter

- name: Display all outstanding messages issued on system MV2H
  zos_operator_action_query:
      system: mv2h

Scanned by Steampunk Spotter

- name: Display all outstanding messages whose job name begin with im5
  zos_operator_action_query:
      job_name: im5*

Scanned by Steampunk Spotter

- name: Display all outstanding messages whose message id begin with dsi*
  zos_operator_action_query:
      message_id: dsi*

Scanned by Steampunk Spotter

- name: Display all outstanding messages that have the text IMS READY in them
  zos_operator_action_query:
      message_filter:
          filter: IMS READY

Scanned by Steampunk Spotter

- name: Display all outstanding messages where the job name begins with 'mq',
        message ID begins with 'dsi', on system 'mv29' and which contain the
        pattern 'IMS'
  zos_operator_action_query:
      job_name: mq*
      message_id: dsi*
      system: mv29
      message_filter:
          filter: ^.*IMS.*$
          use_regex: yes

Inputs

system:
description:
- Return outstanding messages requiring operator action awaiting a reply for a particular
system.
- If the system name is not specified, all outstanding messages for that system and
for the local systems attached to it are returned.
- A trailing asterisk, (*) wildcard is supported.
required: false
type: str

job_name:
description:
- Return outstanding messages requiring operator action awaiting a reply for a particular
job name.
- If the message job name is not specified, all outstanding messages for all job names
are returned.
- A trailing asterisk, (*) wildcard is supported.
required: false
type: str

message_id:
description:
- Return outstanding messages requiring operator action awaiting a reply for a particular
message identifier.
- If the message identifier is not specified, all outstanding messages for all message
identifiers are returned.
- A trailing asterisk, (*) wildcard is supported.
required: false
type: str

message_filter:
description:
- Return outstanding messages requiring operator action awaiting a reply that match
a regular expression (regex) filter.
- If the message filter is not specified, all outstanding messages are returned regardless
of their content.
required: false
suboptions:
filter:
description:
- Specifies the substring or regex to match to the outstanding messages, see I(use_regex).
- All special characters in a filter string that are not a regex are escaped.
- Valid Python regular expressions are supported. See L(the official documentation,https://docs.python.org/library/re.html)
for more information.
- Regular expressions are compiled with the flag B(re.DOTALL) which makes the
B('.') special character match any character including a newline."
required: true
type: str
use_regex:
default: false
description:
- Indicates that the value for I(filter) is a regex or a string to match.
- If False, the module assumes that I(filter) is not a regex and matches the I(filter)
substring on the outstanding messages.
- If True, the module creates a regex from the I(filter) string and matches it
to the outstanding messages.
required: false
type: bool
type: dict

Outputs

actions:
  contains:
    job_id:
      description: Job identifier for the outstanding message requiring operator action
        awaiting a reply.
      returned: on success
      sample: STC01537
      type: str
    job_name:
      description: Job name for outstanding message requiring operator action awaiting
        a reply.
      returned: success
      sample: IM5HCONN
      type: str
    message_id:
      description: Message identifier for outstanding message requiring operator action
        awaiting a reply.
      returned: success
      sample: HWSC0000I
      type: str
    message_text:
      description: Content of the outstanding message requiring operator action awaiting
        a reply. If I(message_filter) is set, I(message_text) will be filtered accordingly.
      returned: success
      sample: '*399 HWSC0000I *IMS CONNECT READY* IM5HCONN'
      type: str
    number:
      description: The message identification number.
      returned: on success
      sample: 1
      type: int
    system:
      description: System on which the outstanding message requiring operator action
        awaiting a reply.
      returned: on success
      sample: MV27
      type: str
    type:
      description: The action type,'R' means request.
      returned: on success
      sample: R
      type: str
  description: The list of the outstanding messages.
  elements: dict
  returned: success
  sample:
  - job_id: STC01537
    job_name: IM5HCONN
    message_id: HWSC0000I
    message_text: '*399 HWSC0000I *IMS CONNECT READY* IM5HCONN'
    number: '001'
    system: MV27
    type: R
  - job_id: STC01533
    job_name: IM5HCTRL
    message_id: DFS3139I
    message_text: '*400 DFS3139I IMS INITIALIZED, AUTOMATIC RESTART PROCEEDING IM5H'
    number: '002'
    system: MV27
    type: R
  type: list
changed:
  description: Indicates if any changes were made during module operation. Given operator
    action commands query for messages, True is always returned unless either a module
    or command failure has occurred.
  returned: always
  sample: false
  type: bool
count:
  description: The total number of outstanding messages.
  returned: on success
  sample: 12
  type: int

Install collection

Add to requirements.yml

Description

Usage examples

Inputs

Outputs

See also