hitachivantara.vspone_block.sds_block.hv_sds_block_login_message_facts module – Get the login message displayed in the GUI login window and CLI warning banner.
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_login_message_facts.
New in hitachivantara.vspone_block 4.6.0
Synopsis
- Retrieves the message configured to be displayed on the GUI login window and CLI warning banner of the storage system.
- For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sds_block_login_message_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:
|
|
password string / required |
Password for authentication. This is a required field. |
|
username string / required |
Username for authentication. This is a required field. |
Attributes
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Determines if the module should run in check mode. |
Examples
- name: Get the current login message
hitachivantara.vspone_block.sds_block.hv_sds_block_login_message_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
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 |
|---|---|
login_message dictionary | The message displayed in the GUI login window and CLI warning banner. Returned: always |
|
message string |
Message body to be displayed in the GUI login window and CLI warning banner. Specify an empty string “” if nothing is to be displayed. Returned: success Sample: |
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_login_message_facts_module.html
