SetLoginBanner

Contributors netapp-mwallis ntap-bmegan Download PDF of this page

You can use the SetLoginBanner method to configure the Terms of Use banner that users see when they log in to the Element web interface.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

banner

The desired text of the Terms of Use banner. The maximum length allowed is 4,096 characters.

string

None

No

enabled

The status of the Terms of Use banner. Possible values:

  • true: The Terms of Use banner is displayed upon web interface login.

  • false: The Terms of Use banner is not displayed upon web interface login.

boolean

None

No

Return values

This method has the following return values:

Name Description Type

banner

The current text of the Terms of Use banner. This value can contain text even when the banner is disabled.

string

enabled

The status of the Terms of Use banner. Possible values:

  • true: The Terms of Use banner is displayed upon web interface login.

  • false: The Terms of Use banner is not displayed upon web interface login.

boolean

Request example

Requests for this method are similar to the following example:

{
  "id": 3920,
  "method": "SetLoginBanner",
  "params": {
    "banner": "Welcome to NetApp!",
    "enabled": true
  }
}

Response example

This method returns a response similar to the following example:

{
  "id": 3920,
  "result": {
    "loginBanner": {
      "banner": "Welcome to NetApp!",
      "enabled": true
    }
  }
}

New since version

10.0