hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_environment_settings module – Manages encryption environment settings on VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.5.0

Synopsis

• This module manages encryption environment configuration settings on Hitachi SDS Block storage systems.

• Enables or disables encryption functionality for the storage environment.

• Utilizes the Hitachi Vantara SDS Block API for encryption environment configuration management.

• For usage examples, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/encryption_environment_settings.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: "direct" ← (default)
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary / required	Specification for encryption environment settings.
is_encryption_enabled boolean / required	Specify whether to enable or disable encryption environment settings. Choices: false true

Attributes

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

Examples

- name: Enable encryption environment
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_environment_settings:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      is_encryption_enabled: true

- name: Disable encryption environment
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_environment_settings:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      is_encryption_enabled: false

Return Values

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

Key	Description
encryption_environment_setting dictionary	Information about the encryption environment settings. Returned: always
free_keys_warning_threshold integer	The warning threshold for the number of encryption keys not allocated to encryption targets. Returned: success Sample: 2000
is_enabled boolean	Indicates whether the encryption environment settings are enabled or disabled. Returned: success Sample: true
is_encryption_key_management_server_in_use boolean	Indicates whether to use an encryption key management server. Returned: success Sample: false

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)