hitachivantara.vspone_block.sds_block.hv_sds_block_session_facts module – Retrieves information about 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_facts.

New in hitachivantara.vspone_block 4.5.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about sessions.
It provides details about a session.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_session_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 session information.
id string	ID of the session to retrieve information for.
user_id string	User ID.
vps_id string	The ID of the virtual private storage (VPS) that the acquisition-target resource belongs to.

Attributes

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

Examples

- name: Get all Sessions
  hitachivantara.vspone_block.sds_block.hv_sds_block_session_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get Session by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_session_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "464e1fd1-9892-4134-866c-6964ce786676"

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
sessions list / elements=dictionary	List of active user sessions on the system. Returned: always
created_time string	The UTC time when the session was created. Returned: always Sample: `"2025-11-05T22:58:40Z"`
expiration_time string	The UTC time when the session will expire. Returned: always Sample: `"2025-11-06T22:58:40Z"`
last_access_time string	The UTC time when the session was last accessed. Returned: always Sample: `"2025-11-05T22:58:41Z"`
privileges list / elements=dictionary	List of privileges assigned to the session. Returned: always
role_names list / elements=string	List of role names associated with the session privileges. Returned: always Sample: `["Audit", "Security", "Storage", "Monitor", "Service", "Resource", "RemoteCopy"]`
scope string	Scope of the privileges. Returned: always Sample: `"system"`
role_names list / elements=string	List of roles assigned to the user in this session. Returned: always Sample: `["Audit", "Security", "Storage", "Monitor", "Service", "Resource", "RemoteCopy"]`
session_id string	Unique identifier for the session. Returned: always Sample: `"d62a9719-f1fd-40f6-8c18-5a04794c74a0"`
user_id string	ID of the user who owns the session. Returned: always Sample: `"admin"`
user_object_id string	Object identifier of the user associated with the session. Returned: always Sample: `"admin"`
vps_id string	The ID of the virtual private storage (VPS) instance associated with the session. Returned: always 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_facts_module.html