Try SpotterRetrieves custom information about jobs in the active workload
| "added in version" 1.0.0 of broadcom.ca7"
Authors: Daniel Remta <daniel.remta@broadcom.com> (@broadcom)
| supported by Broadcom
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install broadcom.ca7:==2.0.7
collections:
- name: broadcom.ca7
version: 2.0.7Displays information about jobs in the active workload.
- name: List a CA 7 job (7777) information which resided in CA7DB database
broadcom.ca7.list_job_instance_list_custom:
ca7no: 7777
databasename: CA7DB
jobname: TESTCA7
arf:
description:
- Arf=true/false
- ''
- Y if this job is monitored by ARF, N if not
- .
required: false
type: bool
job:
description:
- Job=true/false
- ''
- The job name for this job in the active workload
- .
required: false
type: bool
uid:
description:
- Uid=true/false
- ''
- The CA 7 internal user security designation
- .
required: false
type: bool
held:
description:
- Held=true/false
- ''
- Y if job is held, N if not
- .
required: false
type: bool
host:
description:
- Host name of the CA7 API service that is running on the mainframe system.
required: true
type: str
port:
description:
- Port for the CA7 API service that is running on the mainframe system.
required: true
type: int
user:
description:
- User name for authenticating connections to the CA7 API service that is running
on the mainframe system.
required: true
type: str
ca7no:
description:
- Ca7no=0231
- ''
- The CA 7 job number
- .
required: false
type: int
lterm:
description:
- Lterm=true/false
- ''
- Logical terminal name from job definition
- .
required: false
type: bool
maint:
description:
- Maint=true/false
- ''
- Y if job ignores requirements, N if not
- .
required: false
type: bool
arfset:
description:
- Arfset=true/false
- ''
- The collection of ARF definitions that apply to this job
- .
required: false
type: bool
ca7_no:
description:
- Ca7No=true/false
- ''
- The difference between the original dueout time and the original submit time, used
by repeating jobs
- .
required: false
type: bool
drmode:
description:
- Drmode=true/false
- ''
- Y if this job entered the queues when disaster recovery mode was active, N if not
- .
required: false
type: bool
has_jo:
description:
- HasJo=true/false
- ''
- 'Y if the JCL or PARM DATA contains a #JO card, N if not'
- .
required: false
type: bool
jes_hi:
description:
- JesHi=true/false
- ''
- JES supports ID > 99999
- .
required: false
type: bool
locked:
description:
- Locked=true/false
- ''
- Y if job is locked, N if not
- .
required: false
type: bool
mainid:
description:
- Mainid=true/false
- ''
- If positive, the CPU number on which the job may execute. If negative, the CPU number
on which the job may not execute
- .
required: false
type: bool
prompt:
description:
- Prompt=true/false
- ''
- Y if job should have LATE PROMPTS, N if not
- .
required: false
type: bool
status:
description:
- Status=true/false
- ''
- The job status
- .
required: false
type: bool
verify:
description:
- Verify=true/false
- ''
- Y if job has a manual verification requirement, N if not
- .
required: false
type: bool
abended:
description:
- Abended=true/false
- ''
- Y if job abended, N if not
- .
required: false
type: bool
ca7_num:
description:
- Ca7Num=true/false
- ''
- The job number for this job in the active workload
- .
required: false
type: bool
cpm_jfm:
description:
- CpmJfm=true/false
- ''
- Y if JFM is used to track CPM, N if not
- .
required: false
type: bool
cputime:
description:
- Cputime=true/false
- ''
- This Job's average CPU time
- .
required: false
type: bool
drclass:
description:
- Drclass=true/false
- ''
- The job's disaster recovery class
- .
required: false
type: bool
dup_job:
description:
- DupJob=true/false
- ''
- Y if a job with the same name is waiting on this job to complete, N if not
- .
required: false
type: bool
express:
description:
- Express=true/false
- ''
- Y if submission of this job has been expedited by use of the SUBMIT,EXPRESS=YES
command, N if not
- .
required: false
type: bool
jes_num:
description:
- JesNum=true/false
- ''
- The JES job number for this job. A value of -1 indicates NA
- .
required: false
type: bool
jobname:
description:
- Jobname=CA7TEST
- ''
- The CA 7 job name
- .
required: false
type: str
set_ndb:
description:
- SetNdb=true/false
- ''
- Y if job will bypass LOAD processing at completion and not update the database,
N if not
- .
required: false
type: bool
xps_job:
description:
- XpsJob=true/false
- ''
- Y if this is an XPJOB job, N if not
- .
required: false
type: bool
arf_date:
description:
- ArfDate=true/false
- ''
- Y if the job uses ARF
- .
required: false
type: bool
arf_time:
description:
- ArfTime=true/false
- ''
- The date and time that the ARFSET was attached to this job
- .
required: false
type: bool
arfj_job:
description:
- ArfjJob=true/false
- ''
- Y if job is an ARF recovery job, N if not
- .
required: false
type: bool
deadline:
description:
- Deadline=true/false
- ''
- The date and time a job must be started by in order to meet its due out time
- .
required: false
type: bool
end_time:
description:
- EndTime=true/false
- ''
- The date and time this job ended
- .
required: false
type: bool
has_ca11:
description:
- HasCa11=true/false
- ''
- Y if job has a CA11 segment, N if not
- .
required: false
type: bool
override:
description:
- Override=true/false
- ''
- Y if JCL/PARM DATA override is required, N if not
- .
required: false
type: bool
password:
description:
- Password for authenticating connections to the CA7 API service that is running on
the mainframe system.
required: true
type: str
prompted:
description:
- Prompted=true/false
- ''
- Y if user has been prompted, N if not
- .
required: false
type: bool
protocol:
choices:
- http
- https
description:
- Specifies protocol to use for CA7 connection (http or https).
required: true
type: str
skeleton:
description:
- Skeleton=true/false
- ''
- Y if job is in skeleton status, N if not
- .
required: false
type: bool
triggers:
description:
- Triggers=true/false
- ''
- Y if job can trigger other jobs, N if not
- .
required: false
type: bool
base_path:
description:
- 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. Do not specify
this option if you are not using an Zowe API Mediation Layer.
required: false
type: str
cert_file:
description:
- 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.'
required: false
type: path
comp_code:
description:
- CompCode=true/false
- ''
- The job completion code in number format
- .
required: false
type: bool
host_name:
description:
- HostName=true/false
- ''
- The SMF Id of the system where this is executing
- .
required: false
type: bool
jcl_count:
description:
- JclCount=true/false
- ''
- The number of non-# records in the JCL or PARM DATA members associated with this
job
- .
required: false
type: bool
jcl_error:
description:
- JclError=true/false
- ''
- Y if job marked with JCL error, N if not
- .
required: false
type: bool
load_only:
description:
- LoadOnly=true/false
- ''
- Y if this is a LOAD only job, N if not
- .
required: false
type: bool
long_name:
description:
- LongName=true/false
- ''
- An alias name for this job. This name may be used by scheduling engines on other
platforms, such as AutoSys
- .
required: false
type: bool
prose_num:
description:
- ProseNum=true/false
- ''
- Number of the prose text associated with this job, or zero
- .
required: false
type: bool
queue_jcl:
description:
- QueueJcl=true/false
- ''
- Y if a QJCL command is in progress for this job N if not
- .
required: false
type: bool
submitted:
description:
- Submitted=true/false
- ''
- Y if this job has been submitted to the host, N if not
- .
required: false
type: bool
triggered:
description:
- Triggered=true/false
- ''
- Y if job triggered by another job, N if not
- .
required: false
type: bool
xp_status:
description:
- XpStatus=true/false
- ''
- 'The status of the node associated with this XPJOB job. A: Active F: Failed CCI
send O: Offline S:Stopped'
- .
required: false
type: bool
agent_name:
description:
- AgentName=true/false
- ''
- The name of the agent where this job will execute
- .
required: false
type: bool
agent_type:
description:
- AgentType=true/false
- ''
- Agent job type, zero if this is not an agent job
- .
required: false
type: bool
agent_user:
description:
- AgentUser=true/false
- ''
- The userid with which this agent job will execute
- .
required: false
type: bool
autof_done:
description:
- AutofDone=true/false
- ''
- Y if job performed AUTO F, N if not
- .
required: false
type: bool
ca7_system:
description:
- Ca7System=true/false
- ''
- The user-defined application system associated with this job
- .
required: false
type: bool
entry_mode:
description:
- EntryMode=true/false
- ''
- Identifies how the job was brought into the queue.
- .
required: false
type: bool
executable:
description:
- Executable=true/false
- ''
- Y if job is executable, N if not
- .
required: false
type: bool
insert_rms:
description:
- InsertRms=true/false
- ''
- Y if an RMS step will be inserted into this job's JCL, N if not
- .
required: false
type: bool
jclfrom254:
description:
- Jclfrom254=true/false
- ''
- Y if JCL or XPJOB information will be retained in the prior run queue, N if not
- .
required: false
type: bool
needs_load:
description:
- NeedsLoad=true/false
- ''
- Y if LOAD processing will be done for this job, Nif not
- .
required: false
type: bool
no_user_id:
description:
- NoUserId=true/false
- ''
- Y if there is not a valid security id for this job, N if there is
- .
required: false
type: bool
nosecurity:
description:
- Nosecurity=true/false
- ''
- Y if there was an error retrieving security data,N if no
- .
required: false
type: bool
prompt_ack:
description:
- PromptAck=true/false
- ''
- Y if user has acknowledged the prompt, N if not
- .
required: false
type: bool
queue_name:
description:
- QueueName=true/false
- ''
- 'The name of the queue in which this job is currently located. '
- .
required: false
type: bool
retain_jcl:
description:
- RetainJcl=true/false
- ''
- Y if JCL or XPJOB information will be retained in the prior run queue, N if not
- .
required: false
type: bool
rqmt_count:
description:
- RqmtCount=true/false
- ''
- The master requirement count for this job. The number includes unsatisfied requirements,
submit time, and other reasons preventing the job from being submitted
- .
required: false
type: bool
smf_needed:
description:
- SmfNeeded=true/false
- ''
- Y if SMF feedback is needed for this job, N if not
- .
required: false
type: bool
start_time:
description:
- StartTime=true/false
- ''
- The date and time this job started executing on its most recent submission
- .
required: false
type: bool
xplat_node:
description:
- XplatNode=true/false
- ''
- Cross platform long node name
- .
required: false
type: bool
ca11_rms_cc:
description:
- Ca11RmsCc=true/false
- ''
- The CA 11 U11RMS step condition code
- .
required: false
type: bool
complete_ok:
description:
- CompleteOk=true/false
- ''
- Y if job completed normally, N if not
- .
required: false
type: bool
held_by_job:
description:
- HeldByJob=true/false
- ''
- Y if job was held on entry to the queues, N if not
- .
required: false
type: bool
in_cpm_flow:
description:
- InCpmFlow=true/false
- ''
- Y if job is part of a CPM flow, N if not
- .
required: false
type: bool
jcl_library:
description:
- JclLibrary=true/false
- ''
- Contains either a 3 digit JCL index value or a JCL variable beginning with an ampersand
- .
required: false
type: bool
member_name:
description:
- MemberName=true/false
- ''
- The JCL or PARM DATA library member name
- .
required: false
type: bool
needs_autof:
description:
- NeedsAutof=true/false
- ''
- Y if a job changed and requires 'F' in CA11, N if not
- .
required: false
type: bool
node_failed:
description:
- NodeFailed=true/false
- ''
- Y if this is an XPJOB job and at the time of it last submit its node was down, N
if not
- .
required: false
type: bool
repeat_diff:
description:
- RepeatDiff=true/false
- ''
- ''
- .
required: false
type: bool
repeat_type:
description:
- RepeatType=true/false
- ''
- The type of repeat job. This field determines how the submit time requierement is
calculated for repeating jobs
- .
required: false
type: bool
schedule_id:
description:
- ScheduleId=true/false
- ''
- The schedule id for this execution
- .
required: false
type: bool
submit_time:
description:
- SubmitTime=true/false
- ''
- The date and time this job was submitted
- .
required: false
type: bool
xp_alt_node:
description:
- XpAltNode=true/false
- ''
- The alternate node where this XPJOB job was routed
- .
required: false
type: bool
agent_status:
description:
- AgentStatus=true/false
- ''
- The status for this agent job
- .
required: false
type: bool
arf_recovery:
description:
- ArfRecovery=true/false
- ''
- Y if job is in ARF recovery, N if not
- .
required: false
type: bool
databasename:
description:
- Databasename=TESTDB01
- ''
- The CA 7 database name
- .
required: false
type: str
due_out_time:
description:
- DueOutTime=true/false
- ''
- The date and time this job is expected to complete
- .
required: false
type: bool
dup_job_wait:
description:
- DupJobWait=true/false
- ''
- Y if this job is waiting on a job with the same name to complete, N if not
- .
required: false
type: bool
elapsed_time:
description:
- ElapsedTime=true/false
- ''
- This Job's average elapsed time
- .
required: false
type: bool
external_job:
description:
- ExternalJob=true/false
- ''
- Y if this is an externally tracked job, N if not
- .
required: false
type: bool
has_cpu_time:
description:
- HasCpuTime=true/false
- ''
- Y if we have non-zero CPU time for this job, N if not
- .
required: false
type: bool
next_run_req:
description:
- NextRunReq=true/false
- ''
- Y if job has temporary requirements for the next execution, N if not
- .
required: false
type: bool
node_offline:
description:
- NodeOffline=true/false
- ''
- Y if this is an XPJOB job and at the time of its last submit its node was offline,
N if not
- .
required: false
type: bool
node_stopped:
description:
- NodeStopped=true/false
- ''
- Y if this is an XPJOB job and at the time of it last submit its node was stopped,
N if not
- .
required: false
type: bool
qjcl_updated:
description:
- QjclUpdated=true/false
- ''
- Y if JCL or PARM DATA updated through QJCL, N if not
- .
required: false
type: bool
repeat_count:
description:
- RepeatCount=true/false
- ''
- The number of times to repeat this job
- .
required: false
type: bool
restart_step:
description:
- RestartStep=true/false
- ''
- The step name in which the job was restarted
- .
required: false
type: bool
ca11_jes_node:
description:
- Ca11JesNode=true/false
- ''
- The JES node where this job executes
- .
required: false
type: bool
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
curr_step_num:
description:
- CurrStepNum=true/false
- ''
- The number of the step that is currently executing
- .
required: false
type: bool
def_not_found:
description:
- DefNotFound=true/false
- ''
- Y if job defintion not found on database, N if not found
- .
required: false
type: bool
do_not_prompt:
description:
- DoNotPrompt=true/false
- ''
- Y if prompts are bypassed for the job, N if not
- .
required: false
type: bool
forced_submit:
description:
- ForcedSubmit=true/false
- ''
- Y if all input requirements have been marked as satisfied by use of the SUBMIT command,
N if not
- .
required: false
type: bool
has_step_time:
description:
- HasStepTime=true/false
- ''
- Y if job has non-zero step CPU time, N if not
- .
required: false
type: bool
held_skeleton:
description:
- HeldSkeleton=true/false
- ''
- Y if job is held and in skeleton status, N if not
- .
required: false
type: bool
hold_on_entry:
description:
- HoldOnEntry=true/false
- ''
- Y if job marked HOLD=YES, N if not
- .
required: false
type: bool
jcl_alloc_err:
description:
- JclAllocErr=true/false
- ''
- Y if JCL or PARM DATA library could not be allocated, N if not
- .
required: false
type: bool
schd_adjusted:
description:
- SchdAdjusted=true/false
- ''
- Y if job's schedule has been adjusted, N if not
- .
required: false
type: bool
arf_attach_err:
description:
- ArfAttachErr=true/false
- ''
- Y if this job had an ARF attach error, N if not
- .
required: false
type: bool
arf_error_cond:
description:
- ArfErrorCond=true/false
- ''
- Set to Y if there was an error during ARF condition detection, N if not
- .
required: false
type: bool
ca11_subsystem:
description:
- Ca11Subsystem=true/false
- ''
- The CA 11 subsystem name
- .
required: false
type: bool
due_out_exists:
description:
- DueOutExists=true/false
- ''
- Determines if a zero value in DUE_OUT_TIME indicates midnight (Y) or no due out
time (N)
- .
required: false
type: bool
external_input:
description:
- ExternalInput=true/false
- ''
- Y if we job has external input, N if not
- .
required: false
type: bool
external_total:
description:
- ExternalTotal=true/false
- ''
- The total number of external requirements for this job
- .
required: false
type: bool
load_step_done:
description:
- LoadStepDone=true/false
- ''
- Y if LOAD step ran OK for this job, N if not
- .
required: false
type: bool
manual_requeue:
description:
- ManualRequeue=true/false
- ''
- Y if job has been re-queued to REQUEST queue, N if not
- .
required: false
type: bool
response_error:
description:
- ResponseError=true/false
- ''
- ''
- .
required: false
type: bool
xtracker_inact:
description:
- XtrackerInact=true/false
- ''
- Y if at time of submission, the XTRACKER task is not active for an XPJOB job or
IAS is not active for an agent job, N if not
- .
required: false
type: bool
agent_submitted:
description:
- AgentSubmitted=true/false
- ''
- Y if agent job has been submitted to the agent, N if not
- .
required: false
type: bool
ajb_build_error:
description:
- AjbBuildError=true/false
- ''
- Y if an error occurred while building an XPJOB job AJB or an agent job AFM, N if
not
- .
required: false
type: bool
cpu_table_index:
description:
- CpuTableIndex=true/false
- ''
- Index to the CPU Table entry
- .
required: false
type: bool
forced_complete:
description:
- ForcedComplete=true/false
- ''
- Y if job was force completed, N if not
- .
required: false
type: bool
from_xp_request:
description:
- FromXpRequest=true/false
- ''
- Y if scheduling request for this job came from an XPS client, N if not
- .
required: false
type: bool
jcl_from_altlib:
description:
- JclFromAltlib=true/false
- ''
- Y if JCL or PARM DATA was retrieved from an alternate library, N if not
- .
required: false
type: bool
no_xpsi_parmlib:
description:
- NoXpsiParmlib=true/false
- ''
- Y if this is an XPJOB job and has no PARMLIB, N if not
- .
required: false
type: bool
no_xpsi_xpsparm:
description:
- NoXpsiXpsparm=true/false
- ''
- Y if this is an XPJOB job and has no PARM, N if not
- .
required: false
type: bool
repeat_interval:
description:
- RepeatInterval=true/false
- ''
- The interval between repetitions of the job
- .
required: false
type: bool
xp_primary_node:
description:
- XpPrimaryNode=true/false
- ''
- The primary node associated with this XPJOB job
- .
required: false
type: bool
agent_job_number:
description:
- AgentJobNumber=true/false
- ''
- The job number/PID for this agent job
- .
required: false
type: bool
arf_comp_matched:
description:
- ArfCompMatched=true/false
- ''
- Set to Y if an ARF JOB completion rule matched for this job
- .
required: false
type: bool
arf_job_complete:
description:
- ArfJobComplete=true/false
- ''
- Set to Y if this job's completion has been posted to ARF, N if not
- .
required: false
type: bool
arf_recovery_err:
description:
- ArfRecoveryErr=true/false
- ''
- Y if this job had an error in ARF recovery, N if not
- .
required: false
type: bool
override_applied:
description:
- OverrideApplied=true/false
- ''
- Y if JCL overrides have been applied for this job, N if not
- .
required: false
type: bool
repeat_lead_time:
description:
- RepeatLeadTime=true/false
- ''
- The lead time for this repeat job. This is the amount of time to ensure it completes
before it due out time
- .
required: false
type: bool
repeat_stop_time:
description:
- RepeatStopTime=true/false
- ''
- The date and time on or after which a repeating job will not be repeated
- .
required: false
type: bool
wait_submit_time:
description:
- WaitSubmitTime=true/false
- ''
- Y if this job has a submit time requirement, N if not
- .
required: false
type: bool
agent_status_data:
description:
- AgentStatusData=true/false
- ''
- Y if status data is available for this agent job,N if not
- .
required: false
type: bool
ca11_restart_step:
description:
- Ca11RestartStep=true/false
- ''
- The relative CA 11 restart step number
- .
required: false
type: bool
must_start_exists:
description:
- MustStartExists=true/false
- ''
- Determines if a zero value in MUST_START_TIME indicates midnight (Y) or no deadline
time (N)
- .
required: false
type: bool
agent_intervention:
description:
- AgentIntervention=true/false
- ''
- Y if INTERVENTION REQUIRED condition exists for this agent job, N if not
- .
required: false
type: bool
external_satisfied:
description:
- ExternalSatisfied=true/false
- ''
- The number of satisfied external requirements for this job
- .
required: false
type: bool
repeat_stop_exists:
description:
- RepeatStopExists=true/false
- ''
- Determines if a zero value in REPEAT_STOP_TIME indicates midnight (Y) or no repeat
stop time (N)
- .
required: false
type: bool
triggering_job_num:
description:
- TriggeringJobNum=true/false
- ''
- The CA 7 internal job number of the job that triggered this job or job that created
the data set that triggered this job
- .
required: false
type: bool
reject_unauthorized:
default: true
description:
- Reject self-signed certificates.
required: false
type: bool
ca11_failing_step_num:
description:
- Ca11FailingStepNum=true/false
- ''
- CA 11 Failing Step Number
- .
required: false
type: bool
data:
description: 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.
elements: dict
returned: when returned data is a dictionary
type: list
error:
contains:
additional_details:
description: Detailed message about the failure.
type: str
msg:
description: Short description of the result or failure.
type: str
request:
description: HTTP method used to invoke API service request.
returned: API request failed
type: str
resource:
description: URI of the resource of the API service request.
returned: API request failed
type: str
description: More details about why the action has failed. If the failure is when
calling an API service, the response contains the connection parameters.
returned: error
type: complex
failed:
description: A boolean that indicates if the task was failed or not.
returned: always
type: bool
list:
description: Data from the module execution (a list of data structures).
elements: dict
returned: when returned data is a list
type: list
msg:
description: Short description of the result or failure.
returned: sometimes
type: str
rc:
description: Exit code of the module, successful exit code is 0, failure is typically
1 or higher.
returned: always
type: int
stderr:
description: Details of the error.
returned: error
type: str
stdout:
description: Summary of the result.
returned: success
type: str