mnecas / mnecas.ovirt / 1.5.5 / module / ovirt_job Module to manage jobs in oVirt/RHV | "added in version" 1.0.0 of mnecas.ovirt" Authors: Martin Necas (@mnecas)mnecas.ovirt.ovirt_job (1.5.5) — module
Install with ansible-galaxy collection install mnecas.ovirt:==1.5.5
collections: - name: mnecas.ovirt version: 1.5.5
This module manage jobs in oVirt/RHV. It can also manage steps of the job.
# Examples don't contain auth parameter for simplicity, # look at ovirt_auth module to see how to reuse authentication: - name: Create job with two steps mnecas.ovirt.ovirt_job: description: job_name steps: - description: step_name_A - description: step_name_B
- name: Finish one step mnecas.ovirt.ovirt_job: description: job_name steps: - description: step_name_A state: finished
- name: When you fail one step whole job will stop mnecas.ovirt.ovirt_job: description: job_name steps: - description: step_name_B state: failed
- name: Finish all steps mnecas.ovirt.ovirt_job: description: job_name state: finished
auth: description: - 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:' required: true suboptions: ca_file: description: - A PEM file containing the trusted CA certificates. - The certificate presented by the server will be verified using these CA certificates. - If C(ca_file) parameter is not set, system wide CA certificate store is used. - Default value is set by C(OVIRT_CAFILE) environment variable. type: str compress: default: true description: Flag indicating if compression is used for connection. type: bool headers: description: - Dictionary of HTTP headers to be added to each API call. type: dict hostname: description: - A string containing the hostname of the server, usually something like `I(server.example.com)`. - Default value is set by C(OVIRT_HOSTNAME) environment variable. - Either C(url) or C(hostname) is required. type: str insecure: default: false description: - A boolean flag that indicates if the server TLS certificate and host name should be checked. type: bool kerberos: description: - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. type: bool password: description: - The password of the user. - Default value is set by C(OVIRT_PASSWORD) environment variable. required: true type: str timeout: description: Number of seconds to wait for response. type: int token: description: - Token to be used instead of login with username/password. - Default value is set by C(OVIRT_TOKEN) environment variable. type: str url: description: - A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`. - Default value is set by C(OVIRT_URL) environment variable. - Either C(url) or C(hostname) is required. type: str username: description: - The name of the user, something like I(admin@internal). - Default value is set by C(OVIRT_USERNAME) environment variable. required: true type: str type: dict wait: default: true description: - C(yes) if the module should wait for the entity to get into desired state. type: bool state: choices: - present - absent - started - finished - failed default: present description: - Should the job be C(present)/C(absent)/C(failed). - C(started) is alias for C(present). C(finished) is alias for C(absent). Same in the steps. - Note when C(finished)/C(failed) it will finish/fail all steps. type: str steps: description: - The steps of the job. elements: dict suboptions: description: description: - Description of the step. required: true state: choices: - present - absent - started - finished - failed default: present description: - Should the step be present/absent/failed. - Note when one step fail whole job will fail - Note when all steps are finished it will finish job. type: list timeout: default: 180 description: - The amount of time in seconds the module should wait for the instance to get into desired state. type: int description: description: - Description of the job. - When task with same description has already finished and you rerun taks it will create new job. required: true type: str fetch_nested: default: false description: - If I(True) the module will fetch additional data from the API. - It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying C(nested_attributes). type: bool poll_interval: default: 3 description: - Number of the seconds the module waits until another poll request on entity status is sent. type: int nested_attributes: description: - Specifies list of the attributes which should be fetched from the API. - This parameter apply only when C(fetch_nested) is I(true). elements: str type: list
id: description: ID of the job which is managed returned: On success if job is found. sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c type: str job: description: 'Dictionary of all the job attributes. Job attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/job.' returned: On success if job is found. type: dict