hitachivantara.vspone_object.oneobject_node.hv_storage_class module – Create or update a storage class

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_storage_class.

New in hitachivantara.vspone_object 1.0.0

Synopsis

  • This module creates or updates a storage class 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 creating or updating a storage class.

data_count

integer

The number of data blocks the system will use to store the data.

id

string

The ID of the storage class.

name

string

The name of the storage class.

parity_count

integer

The number of parity blocks generated for redundancy.

state

string

Type of the storage class operation.

Choices:

  • "present"

  • "default"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Create a storage class
  hitachivantara.vspone_object.oneobject_node.hv_storage_class:
    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"
    state: "present"
    spec:
      name: "TestStorageClassJul114"
      data_count: 1
      parity_count: 1

- name: Update a storage class
  hitachivantara.vspone_object.oneobject_node.hv_storage_class:
    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"
    state: "present"
    spec:
      name: "TestStorageClass"
      id: "-635732426"

- name: Update default storage class
  hitachivantara.vspone_object.oneobject_node.hv_storage_class:
    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"
    state: "default"
    spec:
      name: "TestStorageClassUpdated"
      id: "-635732426"

Return Values

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

Key

Description

storage_class

dictionary

Storage class and its attributes.

Returned: success

data_count

integer

The number of data blocks the system will use to store the data.

Returned: success

Sample: 1

id

integer

The ID of the storage class.

Returned: success

Sample: -418384882

name

string

The name of the storage class.

Returned: success

Sample: "TestStorageClassJul114"

parity_count

integer

The number of parity blocks generated for redundancy.

Returned: success

Sample: 1

Authors

  • Hitachi Vantara, LTD. (@hitachi-vantara)