hitachivantara.vspone_block.sds_block.hv_sds_block_cluster_config_facts module – Retrieves cluster configuration information.
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_cluster_config_facts.
New in hitachivantara.vspone_block 4.1.0
Synopsis
- This module retrieves information about SDS Block cluster configuration.
- It provides details about a cluster configuration such as storage nodes, fault domains and other details.
- For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/hv_sds_block_cluster_config_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:
|
|
password string / required |
Password for authentication. This is a required field. |
|
username string / required |
Username for authentication. This is a required field. |
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Determines if the module should run in check mode. |
Notes
Note
- For Get cluster configuration information
-
- This task is supported for VSP One SDS Block on Bare Metal and on Google Cloud, but not supported on AWS or Microsoft Azure.
Examples
- name: Retrieve information about configuration of SDS block clusters
hitachivantara.vspone_block.sds_block.hv_sds_block_cluster_config_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
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 |
|---|---|
clusters list / elements=dictionary | A list of clusters. Returned: success |
|
cluster list / elements=dictionary |
Information about the cluster. Returned: success |
|
cluster_ip_v4_address string |
Cluster’s IP v4 address. Returned: success Sample: |
|
cluster_name string |
Name of the cluster. Returned: success Sample: |
|
dns_server_1 string |
First DNS server’s IP address. Returned: success Sample: |
|
dns_server_2 string |
Second DNS server’s IP address. Returned: success Sample: |
|
ntp_server_1 string |
First NTP server’s IP address. Returned: success Sample: |
|
ntp_server_2 string |
Second NTP server’s IP address. Returned: success Sample: |
|
time_zone string |
Timezone of the cluster. Returned: success Sample: |
|
fault_domains list / elements=dictionary |
Fault domains in the cluster. Returned: success |
|
fault_domain_name string |
Fault domain name. Returned: success Sample: |
|
fc_port_setting list / elements=dictionary |
FC port settings. Returned: success |
|
speed string |
Speed of the port. Returned: success Sample: |
|
topology string |
Topology of the port. Returned: success Sample: |
|
general list / elements=dictionary |
General information about the cluster. Returned: success |
|
cvs_version string |
Software version of the cluster. Returned: success Sample: |
|
nodes list / elements=dictionary |
Information about the storage nodes in the cluster. Returned: success |
|
cluster_master_role string |
Whether the node is cluster master. Returned: success Sample: |
|
compute_network_gateway_1 string |
IP v4 address of the compute network gateway for the storage node. Returned: success Sample: |
|
compute_network_ip_1 string |
IP v4 address of the compute network for the storage node. Returned: success Sample: |
|
compute_network_ip_v6_mode_1 string |
Whether IP v6 address is enabled on the compute network. Returned: success Sample: |
|
compute_network_ipv6_gateway_1 string |
IP v6 address of the compute network gateway for the storage node. Returned: success Sample: |
|
compute_network_ipv6_global_1_1 string |
IP v6 global information of the compute network for the storage node. Returned: success Sample: |
|
compute_network_ipv6_subnet_prefix_1 string |
IP v6 subnet prefix information of the compute network for the storage node. Returned: success Sample: |
|
compute_network_mtu_size_1 integer |
MTU size of the compute network. Returned: success Sample: |
|
compute_network_subnet_1 string |
IP v4 address subnet mask of the compute network for the storage node. Returned: success Sample: |
|
compute_port_protocol_1 string |
Protocol of the compute port. Returned: success Sample: |
|
control_internode_network_route_destination_1 string |
Route destination for the control and inter node networks. Returned: success Sample: |
|
control_internode_network_route_gateway_1 string |
Gateway for the control and inter node networks. Returned: success Sample: |
|
control_internode_network_route_interface_1 string |
Interface information for the control and inter node networks. Returned: success Sample: |
|
control_network_ip string |
IP v4 address of the control network for the storage node. Returned: success Sample: |
|
control_network_mtu_size integer |
MTU size of the compute network. Returned: success Sample: |
|
control_network_subnet string |
IP v4 address subnet mask of the control network for the storage node. Returned: success Sample: |
|
fault_domain_name string |
Fault domain name where this storage node belongs to. Returned: success Sample: |
|
host_name string |
Hostname of the storage node. Returned: success Sample: |
|
internode_network_ip string |
IP v4 address of the inter node network for the storage node. Returned: success Sample: |
|
internode_network_mtu_size integer |
MTU size of the inter node network. Returned: success Sample: |
|
internode_network_subnet string |
IP v4 address subnet mask of the inter node network for the storage node. Returned: success Sample: |
|
number_of_fc_target_port integer |
Number of FC target ports. Returned: success Sample: |
|
protection_domains list / elements=dictionary |
Protection domains in the cluster. Returned: success |
|
async_processing_resource_usage_rate string |
Information about the async processing resource usage rate. Returned: success Sample: |
|
protection_domain_name string |
Protection domain name. Returned: success Sample: |
|
redundant_policy string |
Redundant policy information. Returned: success Sample: |
|
redundant_type string |
Redundant type information. Returned: success Sample: |
|
storage_pool_name string |
Name of the storage pool. Returned: success Sample: |
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_cluster_config_facts_module.html
