hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts module – Retrieves information about storage system jobs.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.8.1).

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
Requirements
Parameters
Attributes
Examples
Returned Facts

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
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving job information.
count integer	The number of jobs to be retrieved. Required for the Get information about most recent 10 jobs task.
id string	The ID of the job. Required for the Get job by ID task.

Attributes

Attribute	Support	Description
check_mode	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
jobs list / elements=dictionary	A list of jobs. Returned: success
job_info dictionary	Information about the job. Returned: success
affected_resources list / elements=dictionary	List of resources affected by the job. Returned: success Sample: `[]`
completed_time string	The time when the job was completed. Returns null if the job is not completed. Returned: success Sample: `"2025-07-14T12:46:39Z"`
created_time string	The time when the job was created. Returned: success Sample: `"2025-07-14T12:46:39Z"`
error dictionary	Error details if the job failed. Empty dict if no error. Returned: success Sample: `{}`
job_id string	Job ID. Returned: success Sample: `"9595bc64-cd96-428c-8589-725831c36102"`
request dictionary	The HTTP request information that initiated the job. Returned: success
request_body string	Body of the request that started the job. Returned: success Sample: `""`
request_method string	HTTP method used for the request. Returned: success Sample: `"POST"`
request_url string	Request URL path on the appliance. Returned: success Sample: `"/ConfigurationManager/simple/v1/objects/server-certificate/actions/import/invoke"`
self string	API path to the job resource. Returned: success Sample: `"/ConfigurationManager/simple/v1/objects/jobs/0e9944e4-9a98-4533-ae5c-32ddd7e4ddd2"`
state string	The job status. Returned: success Sample: `"Succeeded"`
status string	The progress of the job. Returned: success Sample: `"Completed"`
updated_time string	The time when the job state was updated. Returned: success Sample: `"2025-07-14T12:46:39Z"`
user_id string	Identifier of the user who initiated the job. Returned: success Sample: `"testUser"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_job_facts_module.html