W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_uaig_token_facts module – Retrieves an API token for the Hitachi gateway service host.

Note

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

New in hitachivantara.vspone_block 3.0.0

DEPRECATED
Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values
Status

DEPRECATED

Removed in:: version 4.0.0
Why:: The connection type gateway is deprecated.
Alternative:: Not available.

Synopsis

This module retrieves an API token for the gateway.
The API token is valid for 10 hours.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_uai_gateway/uai_gateway_token.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 UAI gateway.
address string / required	IP address or hostname of the UAI gateway.
password string / required	Password for authentication. This is a required field for token generation.
username string / required	Username for authentication. This is a required field for token generation.

Attributes

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

Notes

Note

This module is deprecated and will be removed in a future release.

Examples

- name: Retrieve API token for the gateway
  hitachivantara.vspone_block.vsp.hv_uaig_token_facts:
    connection_info:
      address: gateway.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
api_token dictionary	API token for the gateway. Returned: always
token string	The retrieved API token. Returned: success Sample: `"eyJhbGci..."`

Status

This module will be removed in version 4.0.0. [deprecated]
For more information see DEPRECATED.

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_uaig_token_facts_module.html