Setting a message to be displayed at login and during CLI Basic authentication (CLI or REST API)

Virtual Storage Platform One SDS Block System Administrator Guide
Version
1.16.x
Audience
anonymous
Part Number
MK-24VSP1SDS001-03

You can set a message to be displayed in the VSP One SDS Block Administrator login window, at the console interface login, and in the warning banner during CLI Basic authentication.

To set such a message, you have to have the Security role. Role-based execution is not subject to restriction for obtaining the set message.

  • Required role: Security

  1. Set a message.

    Run either of the following commands with the message body specified. If you want to delete the existing message, specify an empty string.

    The maximum number of characters that can be specified is 6144. Specify a message in ASCII printable characters.

    REST API: PATCH /configuration/login-message

    CLI: login_message_set

    Verify the job ID which is displayed after the command is run.

    Note:

    • The screen size of the console interface is 80 x 24 character units. Set the message considering the screen size. If there are too many characters or line breaks, the message might be cut off.

    • The specified message is applied to the console interface by the internal processing that runs in one-minute cycle, and event log KARS20069-I is output. Therefore, it takes a certain amount of time until the message is applied.

    • No event log is output when you perform the following operation:

      • You set a message to be displayed in the login window or in the warning banner during CLI basic authentication. However, there is no change in the content of the message.

  2. Verify the state of the job by specifying the job ID.

    REST API: GET /v1/objects/jobs/<jobID>

    CLI: job_show

    If the job state is "Succeeded", the job is completed.

  3. Verify that the specified message was set correctly.

    REST API: GET /configuration/login-message

    CLI: login_message_show

    The set message will be displayed. If nothing is displayed, no message is set.

  4. (Bare metal) Back up the configuration information.

    Perform this step by referring to Backing up the configuration information (Bare metal).

    If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.

    Note:

    If the CLI execution does not require authentication or it performs session authentication, nothing is displayed even if a message is set.