hitachivantara.vspone_block.sds_block.hv_sds_block_authentication_ticket module – Manages authentication tickets for 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_authentication_ticket.

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows for the creation, deletion and updating of authentication tickets.
It supports various authentication ticket operations based on the specified task level.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/authentication_ticket.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 the authentication ticket task.
max_age_days integer	Supported range: 1 to 365. If omitted, the ticket expiration date and time are the same as that for the password of the user who issued the ticket. However, if the user’s password does not have an expiration time, the ticket will be valid for 365 days. Optional for the Issue a new authentication ticket task.
state string	The level of the authentication ticket 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.

Notes

Note

For Issue a new authentication ticket
1. This authentication ticket is used when basic or session authentication fails. It enables access to APIs or CLI commands—such as those for creating dump files—that support ticket-based authentication.

Examples

- name: Create a authentication ticket
  hitachivantara.vspone_block.sds_block.hv_sds_block_authentication_ticket:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      max_age_days: 15

- name: Discard all authentication tickets
  hitachivantara.vspone_block.sds_block.hv_sds_block_authentication_ticket:
    state: absent
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

Return Values

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

Key	Description
ticket_info dictionary	Dictionary containing the authentication ticket details. Returned: always
expiration_time string	Expiration time of the authentication ticket in ISO 8601 format. Returned: success Sample: `"2025-07-15T05:18:28Z"`
ticket string	The authentication ticket string. Returned: success Sample: `"2025-07-15T05_"`

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