hitachivantara.vspone_object.oneobject_node.hv_jobs_facts module – Get job information from VSP One Object

Note

This module is part of the hitachivantara.vspone_object collection (version 1.0.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_object. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_object.oneobject_node.hv_jobs_facts.

New in hitachivantara.vspone_object 1.0.0

Synopsis 

This module queries jobs from Hitachi VSP One Object.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 3.7

Parameters 

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the system.
cluster_name string / required	Cluster name of the system.
http_request_retry_interval_seconds integer / required	Interval between retries of an HTTP request.
http_request_retry_times integer / required	Number of times to retry an HTTP request.
http_request_timeout integer / required	Timeout for HTTP requests.
oneobject_node_client_id string / required	Id for authentication.
oneobject_node_client_secret string	Secret for authentication.
oneobject_node_username string / required	Username for authentication.
oneobject_node_userpass string / required	Password for authentication.
region string / required	Region of the system.
ssl dictionary	SSL configuration.
ca_certs string	Path to the CA certificates file. Default: `""`
ca_path string	Path to the CA certificate file. Default: `""`
check_hostname boolean	Whether to check the hostname. Choices: `false` ← (default) `true`
client_cert string	Path to the client certificate file. Default: `""`
client_key string	Path to the client key file. Default: `""`
ssl_cipher string	SSL cipher to use. Default: `""`
ssl_version string	SSL version to use. Default: `""`
validate_certs boolean / required	Whether to validate SSL certificates. Choices: `false` `true`
spec dictionary	Request parameters for fetching jobs.
bucket_name string	Bucket name.
job_id integer	UUID of the jobs.
page_size integer	Number of items to return in a page.
query_type string	Depends on if we need ALL Jobs list or STATUS of specific job Choices: `"ALL"` `"STATUS"`
user_id integer	ID of the user.

Attributes 

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples 

- name: Get all jobs
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      user_id: -468170324
      bucket_name: "testbucket"

- name: Get job status
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      job_id: -769908758
      query_type: "STATUS"

- name: Get n number of jobs
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      user_id: -468170324
      bucket_name: "testbucket"
      page_size: 5

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	List of jobs with their attributes. Returned: success
complete_time float	The completion time of the job. Returned: success Sample: `1752770724.423`
job_id dictionary	The ID of the job. Returned: success
id integer	The unique identifier of the job. Returned: success Sample: `-769908758`
job_state string	The current state of the job. Returned: success Sample: `"COMPLETE"`
job_stats dictionary	Statistics related to the job. Returned: success
failed integer	Number of failed operations. Returned: success Sample: `0`
processed integer	Number of processed items. Returned: success Sample: `0`
job_type string	The type of job. Returned: success Sample: `"BATCH_REPLICATE"`
start_time float	The start time of the job. Returned: success Sample: `1752770711.809`

Authors

Hitachi Vantara, LTD. (@hitachi-vantara)

hitachivantara.vspone_object.oneobject_node.hv_jobs_facts module – Get job information from VSP One Object

Synopsis

Requirements

Parameters

Attributes

Examples

Returned Facts