hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts module – Retrieves information about Hitachi SDS block storage system storage nodes.
Note
This module is part of the hitachivantara.vspone_block collection (version 4.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install hitachivantara.vspone_block
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts
.
New in hitachivantara.vspone_block 4.1.0
Synopsis
This module retrieves information about jobs.
It provides details about a job such as ID, state, status and other details.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/job_facts.yml
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
Information required to establish a connection to the storage system. |
|
IP address or hostname of the storage system. |
|
Type of connection to the storage system. Choices:
|
|
Password for authentication. This is a required field. |
|
Username for authentication. This is a required field. |
|
Specification for retrieving job information. |
|
The number of jobs to be retrieved. |
|
The ID of the job. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Determines if the module should run in check mode. |
Examples
- name: Retrieve information about most recent 100 jobs
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
- name: Retrieve information about most recent 10 jobs
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
spec:
count: 10
- name: Retrieve information about job by fault job ID
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
spec:
id: "c0b833cd-1fee-417d-bbf2-d25aac767ad4"
Returned Facts
Facts returned by this module are added/updated in the hostvars
host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
Key |
Description |
---|---|
A list of jobs. Returned: success |
|
Information about the job. Returned: success |
|
The time when the job was completed. Returns null if the job is not completed. Returned: success Sample: |
|
The time when the job was created. Returned: success Sample: |
|
Job ID. Returned: success Sample: |
|
The job status. Returned: success Sample: |
|
The progress of the job. Returned: success Sample: |
|
The time when the job state was updated. Returned: success Sample: |