hitachivantara.vspone_block.sds_block.hv_sds_block_protection_domain module – Manages protection domains on VSP One SDS Block and Cloud systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.9.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_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_protection_domain.

New in hitachivantara.vspone_block 4.4.0

Synopsis

• This module manages protection domains including creation, modification, and data relocation operations on Hitachi SDS Block storage systems.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/protection_domain.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.
ca_cert string	Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate. Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate. Accepts a PEM file path or a directory of hashed CA certificates.
client_cert string	Path to client SSL certificate file or CA certificate directory for mutual TLS authentication. Must be provided together with connection_info.client_key.
client_key string	Path to the client private key file for mutual TLS authentication. Must be provided together with connection_info.client_cert.
connection_type string	Type of connection to the storage system. Choices: "direct" ← (default)
password string / required	Password for authentication. This is a required field.
suppress_validate_cert_warning boolean	Whether to suppress the SSL certificate validation warning. When set to false (default), a warning is displayed if certificate validation is disabled. Set to true to suppress the warning. Choices: false ← (default) true
username string / required	Username for authentication. This is a required field.
validate_cert boolean	Whether to validate the storage system SSL certificate. When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true. Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate. Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments. Choices: false ← (default) true
spec dictionary / required	Specification for the protection domain settings.
async_processing_resource_usage_rate string	The resource usage rate for asynchronous processing choices are very_high, high, middle, low.
id string	The ID of the protection domain.
state string	The desired state of the protection domain. Choices: "present" ← (default) "resume_drive_data_relocation" "suspend_drive_data_relocation"

Attributes

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

Examples

- name: Configure protection domain settings
  hitachivantara.vspone_block.hv_sds_block_protection_domain:
    connection_info:
      address: "{{ management_address }}"
      username: "{{ management_username }}"
      password: "{{ management_password }}"
    state: present
    spec:
      id: "PD001"
      async_processing_resource_usage_rate: "high"

- name: Resume drive data relocation for protection domain
  hitachivantara.vspone_block.hv_sds_block_protection_domain:
    connection_info:
      address: "{{ management_address }}"
      username: "{{ management_username }}"
      password: "{{ management_password }}"
    state: resume_drive_data_relocation
    spec:
      id: "PD001"

- name: Suspend drive data relocation for protection domain
  hitachivantara.vspone_block.hv_sds_block_protection_domain:
    connection_info:
      address: "{{ management_address }}"
      username: "{{ management_username }}"
      password: "{{ management_password }}"
    state: suspend_drive_data_relocation
    spec:
      id: "PD001"

Return Values

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

Key	Description
protection_domain_settings dictionary	Dictionary containing the discovered properties of the protection domains. Returned: always
async_processing_resource_usage_rate string	Usage level of asynchronous processing resources. Returned: success Sample: "High"
drive_data_relocation_progress_rate integer	Progress percentage of data relocation. -1 if not active. Returned: success Sample: -1
drive_data_relocation_status string	Current status of drive data relocation. Returned: success Sample: "Stopped"
id string	Unique identifier for the protection domain. Returned: success Sample: "265ba632-f08e-456c-b4a6-df46b1adaf99"
is_fast_rebuild_enabled boolean	Whether fast rebuild is enabled for the protection domain. Returned: success Sample: true
memory_mode string	Memory mode used in the protection domain. Returned: success Sample: "VolatileMemory"
minimum_memory_size integer	Minimum memory size in MB. Returned: success Sample: 131072
name string	Name of the protection domain. Returned: success Sample: "SC01-PD01"
number_of_fault_domains integer	The total number of fault domains in the protection domain. Returned: success Sample: 1
number_of_fault_sets integer	The total number of fault sets in the protection domain. -1 if not applicable. Returned: success Sample: -1
rebuild_progress_rate integer	Rebuild progress rate as a percentage. -1 if not active. Returned: success Sample: -1
rebuild_status string	Current rebuild status. Returned: success Sample: "Stopped"
redundant_policy string	Redundancy policy used by the protection domain. Returned: success Sample: "Mirroring"
redundant_type string	Redundancy type used in the protection domain. Returned: success Sample: "Duplication"
storage_controller_clustering_policy string	Clustering policy of the storage controllers. Returned: success Sample: "OneRedundantStorageNode"
total_physical_capacity integer	Total physical capacity in MB. Returned: success Sample: 0

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)