Warning: This document is for an old version of IBM z/OSMF Collection. The latest version is v3.0.0.

zmf_job_query

IBM z/OSMF collection provides provides an Ansible role, referred to as zmf_job_query, to query a job running on z/OS, and check its return code.

Role Variables

zmf_host

Hostname of the z/OSMF server, specified via inventory or vars file.

required: True
type: str
zmf_port

Port number of the z/OSMF server, specified via inventory file or vars file.

required: False
type: int
zmf_user

User name to be used for authenticating with z/OSMF server, prompted when playbook is run.

Required when zmf_crt and zmf_key are not supplied.

If zmf_crt and zmf_key are supplied, zmf_user and zmf_password are ignored.

required: False
type: str
zmf_password

Password to be used for authenticating with z/OSMF server, prompted when playbook is run.

Required when zmf_crt and zmf_key are not supplied.

If zmf_crt and zmf_key are supplied, zmf_user and zmf_password are ignored.

required: False
type: str
zmf_crt

Location of the PEM-formatted certificate chain file to be used for HTTPS client authentication.

Required when zmf_user and zmf_password are not supplied.

required: False
type: str
zmf_key

Location of the PEM-formatted file with your private key to be used for HTTPS client authentication.

Required when zmf_user and zmf_password are not supplied.

required: False
type: str
job_name

Job name that identifies the job for which status is requested.

required: True
type: str
job_id

Job ID that identifies the job for which status is requested. The value of this variable is folded to uppercase and cannot exceed eight characters.

required: True
type: str
job_max_rc

An integer value that specifies the maximum return code for the job that should be allowed without failing the role.

The role will fail if the return code doesn’t match CC nnnn where nnnn is small or equal to the maximum return code.

required: False
type: int
default: 0
complete_check_times

The maximum number of time that is used for periodic checks of the job status.

required: False
type: int
default: 10
complete_check_delay

The interval time between periodic checks of the job status.

required: False
type: int
default: 5

Dependencies

None

Requirements

See the section Requirements.

Sample Playbooks

See the sample playbook in section Playbooks.