hitachivantara.vspone_object.oneobject_node.hv_job module – Manage jobs in Hitachi VSP One Object.

Note

This module is part of the hitachivantara.vspone_object collection (version 1.1.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_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_job.

New in hitachivantara.vspone_object 1.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module manages jobs in 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 / required	Request parameters for managing jobs.
bucket_name string	The name of the bucket to operate on.
job_id integer	The ID of the job to manage.
job_parameters dictionary	Arbitrary parameters needed by different Job types.
job_type string	The type of the job to manage. Choices: `"BATCH_REPLICATE"` `"LIFECYCLE_UPDATE"` `"METRIC_RECONCILIATION"` `"TRIGGER_RECONCILIATION"`
state string / required	The state of the job. Choices: `"present"` `"absent"`

Attributes

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

Examples

- name: Create a job in VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_job:
    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_type: "BATCH_REPLICATE"
      bucket_name: "my_bucket"
      job_parameters:
        replication_filter: "ALL"

- name: Cancel a job in VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_job:
    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: 12345

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
job_info dictionary	Job information and its attributes. Returned: success
job_id dictionary	Information about the job ID. 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: `"EXAMINING"`
job_type string	The type of the job. Returned: success Sample: `"BATCH_REPLICATE"`

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_object/oneobject_node.hv_job_module.html