zos_operator – Execute operator command¶
Parameters¶
- cmd
The command to execute.
If the command contains single-quotations, another set of single quotes must be added.
For example, change the command “…,P=’DSN3EPX,-DBC1,S’” to “…,P=’’DSN3EPX,-DBC1,S’’ “.
required: Truetype: str- verbose
Return diagnostic messages that describes the commands execution, options, buffer and response size.
required: Falsetype: booldefault: False- wait_time_s
Set maximum time in seconds to wait for the commands to execute.
When set to 0, the system default is used.
This option is helpful on a busy system requiring more time to execute commands.
Setting wait can instruct if execution should wait the full wait_time_s.
required: Falsetype: intdefault: 1
Examples¶
- name: Execute an operator command to show device status and allocation
zos_operator:
cmd: 'd u'
- name: Execute an operator command to show device status and allocation with verbose information
zos_operator:
cmd: 'd u'
verbose: true
- name: Execute an operator command to purge all job logs (requires escaping)
zos_operator:
cmd: "\\$PJ(*)"
- name: Execute operator command to show jobs, always waiting 5 seconds for response
zos_operator:
cmd: 'd a,all'
wait_time_s: 5
- name: Display the system symbols and associated substitution texts.
zos_operator:
cmd: 'D SYMBOLS'
Return Values¶
- rc
Return code for the submitted operator command.
returned: alwaystype: int- cmd
Operator command submitted.
returned: alwaystype: strsample: d u,all- elapsed
The number of seconds that elapsed waiting for the command to complete.
returned: alwaystype: floatsample:51.53
- wait_time_s
The maximum time in seconds to wait for the commands to execute.
returned: alwaystype: intsample: 5- content
The resulting text from the command submitted.
returned: on successtype: listsample:[ "EC33017A 2022244 16:00:49.00 ISF031I CONSOLE OMVS0000 ACTIVATED", "EC33017A 2022244 16:00:49.00 -D U,ALL ", "EC33017A 2022244 16:00:49.00 IEE457I 16.00.49 UNIT STATUS 645", " UNIT TYPE STATUS VOLSER VOLSTATE SS", " 0000 3390 F-NRD /RSDNT 0", " 0001 3211 OFFLINE 0", " 0002 3211 OFFLINE 0", " 0003 3211 OFFLINE 0", " 0004 3211 OFFLINE 0", " 0005 3211 OFFLINE 0", " 0006 3211 OFFLINE 0", " 0007 3211 OFFLINE 0", " 0008 3211 OFFLINE 0", " 0009 3277 OFFLINE 0", " 000C 2540 A 0", " 000D 2540 A 0", " 000E 1403 A 0", " 000F 1403 A 0", " 0010 3211 A 0", " 0011 3211 A 0" ]
- changed
Indicates if any changes were made during module operation. Given operator commands may introduce changes that are unknown to the module. True is always returned unless either a module or command failure has occurred.
returned: alwaystype: boolsample:true