hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key module – Manage encryption keys on VSP One SDS Block and Cloud systems.

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_encryption_key.

New in hitachivantara.vspone_block 4.5.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Create and delete encryption keys on storage system.

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 key management.
id string	ID of the encryption key (required for deletion).
number_of_keys integer	Number of encryption keys to be created (1-4096).
state string	State of the encryption key. Choices: `"present"` ← (default) `"absent"`

Attributes

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

Examples

- name: Create encryption keys
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      number_of_keys: 5

- name: Delete encryption key
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      id: "07a76cb8-6ad6-475e-a515-4c5f4ac70e09"

Return Values

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

Key	Description
encryption_key string	Deletion result message. Returned: when state is absent Sample: `"Encryption key 07a76cb8-6ad6-475e-a515-4c5f4ac70e09 is deleted successfully."`
encryption_keys list / elements=dictionary	List of created encryption keys. Returned: when state is present
created_time string	Time when the encryption key was created. Returned: success Sample: `"2023-07-09T04:59:17Z"`
id string	Unique identifier for the encryption key. Returned: success Sample: `"1762b15c-0656-48d6-a9f2-3104092b28b9"`
key_generated_location string	Location where the key was generated. Returned: success Sample: `"Internal"`
key_type string	Type of the encryption key. Returned: success Sample: `"Free"`
number_of_backups integer	Number of backups for the encryption key. Returned: success Sample: `0`
target_information string	Target information for the encryption key. Returned: success Sample: `"00000000-0000-0000-0000-000000000000"`
target_name string	Name of the target. Returned: success Sample: `""`

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_block/sds_block.hv_sds_block_encryption_key_module.html