hitachivantara.vspone_object.oneobject_node.hv_storage_components_facts module – Get storage components from 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_storage_components_facts.

New in hitachivantara.vspone_object 1.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module queries storage components 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	Storage component fact module spec
page_size integer	Number of storage components to retrieve per page when querying. This parameter is ignored if the parameter `query` is provided.
query string	Type of query to perform on storage components.

Attributes

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

Examples

- name: Get storage components module
  hosts: localhost
  gather_facts: false
  vars_files:
    - connection_setting.yml
  vars:
    connection_info:
      http_request_timeout: "{{ http_request_timeout }}"
      http_request_retry_times: "{{ http_request_retry_times }}"
      http_request_retry_interval_seconds: "{{ http_request_retry_interval_seconds }}"
      ssl: "{{ ssl }}"
      cluster_name: "{{ cluster_name }}"
      region: "{{ region }}"
      oneobject_node_username: "{{ oneobject_node_username }}"
      oneobject_node_userpass: "{{ oneobject_node_userpass }}"
      oneobject_node_client_id: "{{ oneobject_node_client_id }}"
      oneobject_node_client_secret: "{{ oneobject_node_client_secret }}"

  tasks:
    - name: Get storage components
      hitachivantara.vspone_object.oneobject_node.hv_storage_components_facts:
        connection_info: "{{ connection_info }}"
      register: output_variable

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
storage_components list / elements=dictionary	List of storage components with their attributes. Returned: success
id integer	The ID of the storage component. Returned: success Sample: `1473644437`
storage_capacities dictionary	The storage capacities of the storage component. Returned: success
available_bytes integer	The total number of unused bytes on your S3 component. Returned: success Sample: `100000`
available_capacity string	Available capacity in human-readable format. Returned: success Sample: `"100.0 GB"`
total_bytes integer	The total number of bytes on your S3 component. Returned: success Sample: `10000000000`
total_capacity string	Total capacity in human-readable format. Returned: success Sample: `"10.0 TB"`
used_bytes integer	The total number of used bytes on your S3 component. Returned: success Sample: `9999000000`
used_capacity string	Used capacity in human-readable format. Returned: success Sample: `"9.9 TB"`
warn_threshold integer	The percentage of total capacity usage at which point a warning message is generated. Returned: success Sample: `50`
warn_threshold_capacity string	Warning threshold capacity in human-readable format. Returned: success Sample: `"5.0 TB"`
storage_class_id integer	The id of storage class assigned to the storage component in Kubernetes. Returned: success Sample: `-1128696871`
storage_component_config dictionary	The storage component configuration values. Returned: success
array_lun string	The LUN on the storage array. Returned: success Sample: `"lun1"`
array_name string	The name of the storage array. Returned: success Sample: `"vsp_array_01"`
array_namespace string	The namespace on the storage array. Returned: success Sample: `"namespace1"`
array_storage_tier string	The storage tier on the storage array. Returned: success Sample: `"nvme-tlc"`
auth_type string	The AWS Signature Version for authenticating all interactions with Amazon S3. Returned: success Sample: `"V2"`
bucket string	The name of the bucket. Returned: success Sample: `"test_bucket "`
connection_ttl integer	The connection time to live (TTL) for a request. Returned: success Sample: `0`
host string	The URL of the storage component back-end host domain. Returned: success Sample: `"urloripaddressofcomponent"`
label string	The name of the storage component. Returned: success Sample: `"component-test6"`
management_host string	The management system IP address or fully qualified domain name. Returned: success Sample: `"urloripaddressofcomponentmapi"`
management_protocol string	The communication protocol for MAPI requests. Returned: success Sample: `"HTTPS"`
max_connections integer	The maximum number of connections for the storage component. Returned: success Sample: `1024`
port integer	The HTTP port of the back-end system. Returned: success Sample: `80`
region string	The S3 region. Returned: success Sample: `"us-west-2b"`
site_affiliation dictionary	The site affiliation details for the storage component. Returned: success
id string	The unique identifier of the site affiliation. Returned: success Sample: `"6e8ba3a8-b477-484a-95cf-9d3b29e1699d"`
socket_timeout integer	The timeout value for reading from a connected socket. Returned: success Sample: `31000`
state string	The current state of the storage component. Returned: success Sample: `"UNVERIFIED"`
uri_scheme string	The Uniform Resource Identifier (URI) schema used when accessing the resource. Returned: success Sample: `"HTTP"`
use_path_style_always boolean	Whether to use path-style addressing for the storage component. Returned: success Sample: `false`
use_proxy boolean	Whether to use a proxy for the storage component. Returned: success Sample: `false`
storage_custom_metadata dictionary	Custom metadata for the storage component. Returned: success Sample: `{}`
storage_fault_domain_id string	The unique identifier of the storage fault domain. Returned: success Sample: `"073cddb1-01f2-45a3-8688-50a1483d9e53"`
storage_type string	The type of the storage component. Returned: success Sample: `"HCPS_S3"`

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_storage_components_facts_module.html