W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user_facts module – Retrieves information about Hitachi SDS block storage system CHAP users.

Note

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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about CHAP users.
It provides details about a CHAP user such as initiator CHAP user name, target CHAP user name and ID.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/chap_user_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.
username string / required	Username for authentication.
spec dictionary	Specification for retrieving CHAP user information.
id string	ID of the CHAP user to retrieve information for.
target_chap_user_name string	Target CHAP user name to retrieve information for.

Attributes

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

Examples

- name: Retrieve information about all CHAP users
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about a specific CHAP user by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"

- name: Retrieve information about a specific CHAP user by name
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      target_chap_user_name: "chapuser1"

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
chap_users list / elements=dictionary	List of CHAP users with their attributes. Returned: success
id string	Unique identifier for the CHAP user. Returned: success Sample: `"464e1fd1-9892-4134-866c-6964ce786676"`
initiator_chap_user_name string	Initiator CHAP user name. Returned: success Sample: `"chapuser1"`
target_chap_user_name string	Target CHAP user name. Returned: success Sample: `"newchapuser2"`

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/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_chap_user_facts_module.html