hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user module – Manages Hitachi SDS block storage system CHAP users.

Note

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

New in hitachivantara.vspone_block 3.0.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

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 / required

Specification for the CHAP user task.

id

string

ID of the CHAP user.

initiator_chap_secret

string

Initiator CHAP user secret.

initiator_chap_user_name

string

Initiator CHAP user name.

target_chap_secret

string

Target CHAP user secret.

target_chap_user_name

string

Target CHAP user name.

state

string

The level of the CHAP user task. Choices are present and absent.

Choices:

  • "present" ← (default)

  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Create a CHAP user
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      target_chap_user_name: "chapuser2"
      target_chap_user_secret: "chapuser2_secret"
      initiator_chap_user_name: "chapuser1"
      initiator_chap_secret: "chapuser1_secret"

- name: Delete a CHAP user
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"

- name: Update chap user name
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user:
    state:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"
      target_chap_user_name: "newchapuser2"

- name: Update chap user secret
  hitachivantara.vspone_block.sds_block.hv_sds_block_chap_user:
    state:
    connection_info:
      username: "admin"
      password: "password"
    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"
      target_chap_user_name: "chapuser2"
      target_chap_user_secret: "chapuser2_new_secret"

Return Values

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

Key

Description

chap_users

dictionary

Dictionary containing the discovered properties of the CHAP users.

Returned: always

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)