hitachivantara.vspone_block.sds_block.hv_sds_block_login_message module – Update 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.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

Update 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.yml

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 / required	Specification for the login message to be updated.
login_message string / required	Message body to be displayed in the GUI login window and CLI warning banner. Specify an empty string “” if nothing is to be displayed.
state string	The level of the login message task. Choices: `"present"` ← (default)

Attributes

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

Examples

- name: Update the current login message
  hitachivantara.vspone_block.sds_block.hv_sds_block_login_message:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
        login_message: "login messagee"

Return Values

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

Key	Description
login_message dictionary	The message displayed in the GUI login window and CLI warning banner. Returned: always
login_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: `"login message"`

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