hitachivantara.vspone_block.sds_block.hv_sds_block_session module – Manages sessions 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_session.

New in hitachivantara.vspone_block 4.5.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module allows to generate and discard session.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_session.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 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.
id string	Session ID. UUID format. 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	Information about the user session. Returned: always
created_time string	Timestamp when the session was created. Returned: success Sample: `"2025-11-06T19:22:13Z"`
expiration_time string	Timestamp when the session will expire. Returned: success Sample: `"2025-11-07T19:22:13Z"`
last_access_time string	Timestamp of the last access using this session. Returned: success Sample: `"2025-11-06T19:22:13Z"`
privileges list / elements=dictionary	List of privilege objects associated with the session. Returned: success
role_names list / elements=string	List of role names granted in this privilege. Returned: success Sample: `["Audit", "Security", "Storage", "Monitor", "Service", "Resource", "RemoteCopy"]`
scope string	Scope of the privilege. Returned: success Sample: `"system"`
role_names list / elements=string	List of roles assigned to the session. Returned: success Sample: `["Audit", "Security", "Storage", "Monitor", "Service", "Resource", "RemoteCopy"]`
session_id string	Unique identifier for the session. Returned: success Sample: `"0ba72e6d-b109-4638-bbea-9452ed8401b8"`
token string	Session token used for authentication. Returned: success Sample: `"gAAAAABpDPVlhsNMvLyM5vBrb5oMpKDuChy1vT-HtowicWzZnEHtfLKPvj95U5rzOxdhw3p95ipuREgrkZRTgM2RDTHM3nWQDQD82qxwd50v74XqXTheuztB2506bRqHtLXgUQ..."`
user_id string	ID of the user who owns the session. Returned: success Sample: `"admin"`
user_object_id string	Object ID of the user. Returned: success Sample: `"admin"`
vps_id string	Identifier for the Virtual Private Storage (VPS) or system context. Returned: success Sample: `"(system)"`

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_session_module.html