zmf_workflow_complete¶
IBM z/OSMF collection provides provides an Ansible role, referred to as zmf_workflow_complete, to complete a z/OS workflow, either forcibly or idempotently.
Role Variables¶
- zmf_host
Hostname of the z/OSMF server, specified via inventory or vars file.
required: Truetype: str- zmf_port
Port number of the z/OSMF server, specified via inventory file or vars file.
required: Falsetype: 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: Falsetype: 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: Falsetype: 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: Falsetype: 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: Falsetype: str- force_complete
Specify whether to complete the workflow instance forcibly or idempotently.
Forcibly (force_complete=True): Delete the workflow instance if it exists in the z/OSMF server. Create a new workflow instance and start it on each of the target z/OS systems. Periodically check the workflow status and return the final result when the workflow stops running.
Idempotently (force_complete=False): Create the workflow instance if it does not exist in the z/OSMF server. Start the workflow on each of the target z/OS systems. Periodically check the workflow status and return the final result when the workflow stops running.
required: Falsetype: booldefault: False- complete_check_times
The maximum number of time that is used for periodic checks of the workflow status.
required: Falsetype: intdefault: 10- complete_check_delay
The interval time between periodic checks of the workflow status.
required: Falsetype: intdefault: 5- workflow_name
Descriptive name of the workflow.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Truetype: str- workflow_file
Location of the workflow definition file.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_owner
User name of the workflow owner.
If this value is omitted, zmf_user is used as workflow owner.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_file_system
Nickname of the system on which the specified workflow definition file and any related files reside.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_vars_file
Location of the optional properties file to be used to pre-specify the values of one or more variables that are defined in workflow definition file.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_vars
Values of one or more workflow variables in JSON format.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: dict- workflow_resolve_global_conflict_by_using
Version of the variable to be used if the supplied workflow variable conflicts with an existing global variable in z/OSMF Workflows task.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: strdefault: globalchoices: global, input- workflow_comments
User-specified information to be associated with the workflow at creation time.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_assign_to_owner
Specifies whether the workflow steps are assigned to the workflow owner when the workflow is created.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: booldefault: True- workflow_access_type
Access type for the workflow when the workflow is created.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: strdefault: Publicchoices: Public, Restricted, Private- workflow_account_info
For a workflow that submits a batch job, this variable specifies the account information for the JCL JOB statement.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_job_statement
For a workflow that submits a batch job, this variable specifies the JOB statement JCL for the job.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_delete_completed_jobs
For a workflow that submits a batch job, this variable specifies whether the job is deleted from the JES spool after it completes.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: bool- workflow_resolve_conflict_by_using
Specifies how to handle variable conflicts if any are detected at workflow creation time.
Such conflicts can be found when z/OSMF Workflows task reads the output file from a step that runs a REXX exec or UNIX shell script.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: strdefault: outputFileValuechoices: outputFileValue, existingValue, leaveConflict- workflow_step_name
Name of the workflow step at which automation processing is to begin when the workflow is started.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str- workflow_perform_subsequent
Specifies whether the subsequent automated steps are performed when the workflow is started.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: booldefault: True- workflow_notification_url
URL to be used for notification when the workflow is started.
For more information, see the documentation for the z/OSMF workflow REST services.
required: Falsetype: str
Dependencies¶
module: zmf_workflow
Requirements¶
See the section Requirements.