hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key_facts module – Retrieves encryption key information from 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_facts.

New in hitachivantara.vspone_block 4.5.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves detailed information about encryption keys from Hitachi SDS Block storage systems.
Supports filtering by key ID, type, target resource, creation time, and other criteria.
Utilizes the Hitachi Vantara SDS Block API for encryption key facts retrieval.
For usage examples, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/encryption_key_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: `"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	Specification for retrieving encryption key information.
count integer	Limit the number of encryption keys returned.
end_creation_time string	Filter encryption keys created before this time.
id string	Filter encryption keys by ID.
key_id string	Filter encryption keys by key ID.
key_type string	Filter encryption keys by type.
start_creation_time string	Filter encryption keys created after this time.
target_resource_id string	Filter encryption keys by target resource ID.
target_resource_name string	Filter encryption keys by target resource name.

Attributes

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

Examples

- name: Retrieve information about all encryption keys
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about specific encryption key by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "1762b15c-0656-48d6-a9f2-3104092b28b9"

- name: Retrieve limited number of encryption keys
  hitachivantara.vspone_block.sds_block.hv_sds_block_encryption_key_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      count: 5

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
encryption_keys list / elements=dictionary	A list of encryption key information. Returned: success
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_facts_module.html