hitachivantara.vspone_block.sds_block.hv_sds_block_cluster_config_facts module – Retrieves information about configuration of SDS block clusters from Hitachi SDS block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.2.2).

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

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:

  • "direct" ← (default)

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.

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: "10.76.34.110"

cluster_name

string

Name of the cluster.

Returned: success

Sample: "SC01"

dns_server_1

string

First DNS server’s IP address.

Returned: success

Sample: "10.76.46.10"

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: "10.76.46.1"

ntp_server_2

string

Second NTP server’s IP address.

Returned: success

Sample: ""

time_zone

string

Timezone of the cluster.

Returned: success

Sample: "UTC"

fault_domains

list / elements=dictionary

Fault domains in the cluster.

Returned: success

fault_domain_name

string

Fault domain name.

Returned: success

Sample: "SC01-PD01-FD01"

fc_port_setting

list / elements=dictionary

FC port settings.

Returned: success

speed

string

Speed of the port.

Returned: success

Sample: "Auto"

topology

string

Topology of the port.

Returned: success

Sample: "Point-to-Point"

general

list / elements=dictionary

General information about the cluster.

Returned: success

cvs_version

string

Software version of the cluster.

Returned: success

Sample: "01.17.00.40"

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: "clustermaster"

compute_network_gateway_1

string

IP v4 address of the compute network gateway for the storage node.

Returned: success

Sample: "10.76.27.1"

compute_network_ip_1

string

IP v4 address of the compute network for the storage node.

Returned: success

Sample: "10.76.27.1"

compute_network_ip_v6_mode_1

string

Whether IP v6 address is enabled on the compute network.

Returned: success

Sample: "Disable"

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: 9000

compute_network_subnet_1

string

IP v4 address subnet mask of the compute network for the storage node.

Returned: success

Sample: "255.255.255.0"

compute_port_protocol_1

string

Protocol of the compute port.

Returned: success

Sample: "iSCSI"

control_internode_network_route_destination_1

string

Route destination for the control and inter node networks.

Returned: success

Sample: "default"

control_internode_network_route_gateway_1

string

Gateway for the control and inter node networks.

Returned: success

Sample: "10.76.34.1"

control_internode_network_route_interface_1

string

Interface information for the control and inter node networks.

Returned: success

Sample: "control"

control_network_ip

string

IP v4 address of the control network for the storage node.

Returned: success

Sample: "10.76.34.101"

control_network_mtu_size

integer

MTU size of the compute network.

Returned: success

Sample: 1500

control_network_subnet

string

IP v4 address subnet mask of the control network for the storage node.

Returned: success

Sample: "255.255.255.0"

fault_domain_name

string

Fault domain name where this storage node belongs to.

Returned: success

Sample: "SC01-PD01-FD01"

host_name

string

Hostname of the storage node.

Returned: success

Sample: "SDSB-NODE1"

internode_network_ip

string

IP v4 address of the inter node network for the storage node.

Returned: success

Sample: "10.76.34.101"

internode_network_mtu_size

integer

MTU size of the inter node network.

Returned: success

Sample: 9000

internode_network_subnet

string

IP v4 address subnet mask of the inter node network for the storage node.

Returned: success

Sample: "255.255.255.0"

number_of_fc_target_port

integer

Number of FC target ports.

Returned: success

Sample: 0

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: "VeryHigh"

protection_domain_name

string

Protection domain name.

Returned: success

Sample: "SC01-PD01"

redundant_policy

string

Redundant policy information.

Returned: success

Sample: "HitachiPolyphaseErasureCoding"

redundant_type

string

Redundant type information.

Returned: success

Sample: "4D+1P"

storage_pool_name

string

Name of the storage pool.

Returned: success

Sample: "SP01"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)