hitachivantara.vspone_block.vsp.hv_session_facts module – Retrieves information about sessions on VSP block storage 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.vsp.hv_session_facts.

New in hitachivantara.vspone_block 4.6.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/vsp_direct/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.
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 retrieving session information.
id integer	ID of the session to retrieve information for.
token string	Authentication token for the session. Required when specifying ‘id’.

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.vsp.hv_session_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get Session by ID
  hitachivantara.vspone_block.vsp.hv_session_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: 9
      token: "d7c7bd35d3854a9f973d934800fb70ab"

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 and historical user sessions. Returned: always
created_time string	Session creation timestamp in ISO 8601 format. Returned: success Sample: `"2026-01-18T17:33:12Z"`
ip_address string	IP address from which the session was created. Returned: success Sample: `"172.25.94.70"`
last_access_time string	Timestamp of the last access for the session. Empty if the information is not available. Returned: success Sample: `""`
session_id integer	Unique identifier of the session. Returned: success Sample: `15851`
user_id string	User name associated with the session. Returned: success Sample: `"ucpa"`

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/vsp.hv_session_facts_module.html