ibm.ibm_zos_core.zos_operator_action_query (1.3.6) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: ibm.ibm_zos_core
      version: 1.3.6

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Display all outstanding messages given job_name, message_id, system
  zos_operator_action_query:
      job_name: mq*
      message_id: dsi*
      system: mv29

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

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: Job identifier for outstanding message requiring operator action
        awaiting a reply.
      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

See also

• zos_operator