hitachivantara.vspone_block.vsp.hv_session module – Manages sessions on VSP block storage systems.

Note

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

New in hitachivantara.vspone_block 4.6.0

Synopsis

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.

api_token

string

Token used to operate on locked resources.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string

Password for authentication. This is a required field.

username

string

Username for authentication. This is a required field.

spec

dictionary

Specification for Session.

alive_time_in_seconds

integer

The idle time in seconds after which a session times out. Valid for create session operation. If omitted, 300 is applied. If specified value must be between 1 and 300.

authentication_timeout

integer

Timeout value for authentication processing (in seconds). Valid for create session operation. Specify this value if an external authentication server is being used to authenticate users. Change the value according to the external authentication settings of the storage system. If omitted, 120 is applied. If specified value must be between 1 and 900.

force

boolean

Specify whether to force discarding of the session generated by other users, in addition to the session you generated. Only a user who belongs to the Administrator user group (built-in user group) can specify this attribute. When true, forces discarding of the session generated by other users, in addition to the session you generated. When false, forces discarding of only the session you generated. If you omit this value, false is used.

Choices:

  • false ← (default)

  • true

id

integer

Session ID. Required for delete operation.

token

string

Authentication token for the session. Required for delete operation.

state

string

State of the session.

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 session
  hitachivantara.vspone_block.sds_block.hv_sds_block_session:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      alive_time_in_seconds: 100

- name: Delete a session
  hitachivantara.vspone_block.sds_block.hv_sds_block_session:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
      state: "absent"
      spec:
        id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"

Return Values

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

Key

Description

session

dictionary

Session information returned by the module.

Returned: always

session_id

integer

Unique identifier of the session.

Returned: success

Sample: 15561

token

string

Authentication token associated with the session.

Returned: success

Sample: "d7c7bd35d3854a9f973d934800fb70ab"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)