Skip to main content
Hitachi Vantara Knowledge

Update login banner

Update the login banner contents, and enabled state. If enabled, the login banner is presented to any user who connects to the system via SSH or via the GUI.

HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/file-devices/login-banner
Name Type Required Values Description
bannerContentBODYN stringContent of the login banner.
enabledBODYNbooleanEnabled state of login banner.
Return codes
Code Data Description
204 No DataLogin banner successfully updated.
400 Error Message Missing or invalid request contents.
403Error MessageOperation forbidden by access level.
500 Error message Error associated with the storage system.

Any HTTP status code other than 204 indicates that the API did not complete successfully.

Request example
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" -X PATCH -d '{"enabled":true, "bannerContent":"Welcome to the system\n\nPlease ensure you have the correct permission to access this system."}'
Response example
HTTP/1.1 204 No Content


  • Was this article helpful?