ibm.ibm_zos_zosmf.workflow (1.0.3) — module

Install collection

Install with ansible-galaxy collection install ibm.ibm_zos_zosmf:==1.0.3

Add to requirements.yml

  collections:
    - name: ibm.ibm_zos_zosmf
      version: 1.0.3

Description

Ansible module for running z/OS workflows by issuing z/OSMF workflow RESTful services.

Inputs

    
action:
    choices:
    - compare
    - start
    - check
    - delete
    description:
    - Action to be performed by the module.
    required: true
    type: str

zmf_crt:
    description:
    - Location of the PEM-formatted certificate chain file to be used for HTTPS client
      authentication.
    required: false
    type: str

zmf_key:
    description:
    - Location of the PEM-formatted file with your private key to be used for HTTPS client
      authentication.
    required: false
    type: str

zmf_host:
    description:
    - Hostname of the z/OSMF server.
    required: true
    type: str

zmf_port:
    description:
    - Port number of the z/OSMF server.
    required: false
    type: int

zmf_user:
    description:
    - User name to be used for authenticating with z/OSMF server.
    - If zmf_crt and zmf_key are supplied, zmf_user and zmf_password are ignored.
    required: false
    type: str

zmf_password:
    description:
    - Password to be used for authenticating with z/OSMF server.
    - If zmf_crt and zmf_key are supplied, zmf_user and zmf_password are ignored.
    required: false
    type: str

zos_workflow_key:
    description:
    - Generated key to uniquely identify the workflow instance.
    required: false
    type: str

zos_workflow_file:
    description:
    - Location of the workflow definition file.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_host:
    description:
    - Nickname of the system on which the workflow is to be performed.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_name:
    description:
    - Descriptive name of the workflow.
    - It is recommended that you use the naming rule ansible_workflowName_{{ zos_workflow_host
      }}.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_vars:
    description:
    - Values of one or more workflow variables in JSON format.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: dict

zos_workflow_owner:
    description:
    - 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: false
    type: str

zos_workflow_vender:
    description:
    - Name of the vendor that provided the workflow definition file.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_category:
    choices:
    - general
    - configuration
    description:
    - Category for the workflow.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_comments:
    description:
    - 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: false
    type: str

zos_workflow_step_name:
    description:
    - 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: false
    type: str

zos_workflow_vars_file:
    description:
    - 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: false
    type: str

zos_workflow_access_type:
    choices:
    - Public
    - Restricted
    - Private
    description:
    - Access type for the workflow when the workflow is created.
    - For more information, see the documentation for the z/OSMF workflow REST services.
    required: false
    type: str

zos_workflow_file_system:
    description:
    - 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: false
    type: str

zos_workflow_account_info:
    description:
    - 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: false
    type: str

zos_workflow_job_statement:
    description:
    - 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: false
    type: str

zos_workflow_assign_to_owner:
    description:
    - 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: false
    type: bool

zos_workflow_notification_url:
    description:
    - 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: false
    type: str

zos_workflow_perform_subsequent:
    description:
    - 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: false
    type: bool

zos_workflow_delete_completed_jobs:
    description:
    - 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: false
    type: bool

zos_workflow_resolve_conflict_by_using:
    choices:
    - outputFileValue
    - existingValue
    - leaveConflict
    description:
    - 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: false
    type: str

zos_workflow_resolve_global_conflict_by_using:
    choices:
    - global
    - input
    description:
    - 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: false
    type: str

Outputs

changed:
  description:
  - (action compare) Always be false.
  - (action start) Indicate whether the workflow instance is created and started.
  - (action check) Always be false.
  - (action delete) Indicate whether the workflow instance is deleted.
  returned: always
  type: bool
completed:
  description:
  - (action check) Indicate whether the workflow instance is completed.
  returned: success
  type: bool
deleted:
  description:
  - (action delete) Indicate whether the workflow instance is deleted.
  returned: success
  type: bool
exist_workflow_key:
  description:
  - (action compare) Key for the existing workflow instance.
  returned: success
  type: str
message:
  description:
  - (action compare) Indicate whether the workflow instance does not exist, or exists
    with same or different definition file, variables and properties.
  - (action start) Indicate whether the workflow instance is started.
  - (action check) Indicate whether the workflow instance is completed, is not completed,
    or is still in progress.
  - (action delete) Indicate whether the workflow instance does not exist or is deleted.
  returned: success
  type: str
same_workflow_instance:
  description:
  - (action compare) Indicate whether the existing workflow instance has the same
    or different definition file, variables and properties.
  returned: success
  type: bool
waiting:
  description:
  - (action check) Indicate whether it needs to wait and check again because the workflow
    instance is still in progress.
  returned: success
  type: bool
workflow_completed:
  description:
  - (action compare) Indicate whether the existing workflow instance has been completed.
  returned: success
  type: bool
workflow_key:
  description:
  - (action start) Key for the started workflow instance.
  returned: success
  type: str