SetLoginBanner

SetLoginBannerメソッドを使用すると、ユーザがElement Webインターフェイスにログインしたときに表示される「利用条件」バナーを設定できます。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
banner 利用条件バナーに表示するテキスト。最大文字数は4,096文字です。 文字列 なし ×
enabled 利用条件バナーのステータス。有効な値は次のとおりです。
  • true:Webインターフェイスにログインしたときに利用条件バナーが表示されます。
  • false:Webインターフェイスにログインしたときに利用条件バナーが表示されません。
ブーリアン なし ×

戻り値

このメソッドの戻り値は次のとおりです。

名前 説明 タイプ
banner 利用条件バナーの現在のテキスト。この値には、バナーが無効になっている場合でもテキストが含まれます。 文字列
enabled 利用条件バナーのステータス。有効な値は次のとおりです。
  • true:Webインターフェイスにログインしたときに利用条件バナーが表示されます。
  • false:Webインターフェイスにログインしたときに利用条件バナーが表示されません。
ブーリアン

要求例

このメソッドの要求例を次に示します。

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

応答例

このメソッドの応答例を次に示します。

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