ModifyInitiators

ModifyInitiatorsメソッドを使用すると、1つ以上の既存のイニシエータの属性を変更できます。

既存のイニシエータの名前を変更することはできません。イニシエータの名前を変更する必要がある場合は、まずDeleteInitiatorsメソッドで該当のイニシエータを削除してから、CreateInitiatorsメソッドで新しいイニシエータを作成します。

パラメータで指定されたイニシエータのいずれかの変更にModifyInitiatorsが失敗した場合、メソッドからエラーが返され、どのイニシエータも変更されません(一部だけを完了することはできません)。

パラメータ

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

名前 説明 タイプ デフォルト値 必須
initiators 変更する各イニシエータの特性を含むオブジェクトのリスト。オブジェクトは次のとおりです。
  • alias:(オプション)イニシエータに割り当てる新しいフレンドリ名。(文字列)。
  • attributes:(オプション)イニシエータに割り当てる一連の新しいJSON属性 (JSONオブジェクト)。
  • chapUsername:(オプション)このイニシエータの新しい一意のCHAPユーザ名 (文字列)。
  • forceDuringUpgrade:アップグレード時にイニシエータを変更します。
  • initiatorID:(必須)変更するイニシエータのID (整数)。
  • initiatorSecret:(オプション)イニシエータの認証に使用する新しいCHAPシークレット (文字列)。
  • requireChap:(オプション)このイニシエータに対してCHAPを必須にする場合はtrue (ブーリアン)。
  • targetSecret:(オプション)ターゲットの認証に使用する新しいCHAPシークレット(相互CHAP認証を使用する場合) (文字列)。
  • volumeAccessGroupID:(オプション)イニシエータを追加するボリューム アクセス グループのID。イニシエータがこれまで異なるボリューム アクセス グループに属していた場合、以前のボリューム アクセス グループからは削除されます。このキーが存在するもののNULLの場合、イニシエータは現在のボリューム アクセス グループから削除されますが、新しいボリューム アクセス グループには配置されません (整数)。
JSONオブジェクトの配列 なし

戻り値

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

名前 説明 タイプ
initiators 変更されたイニシエータの詳細を示すオブジェクトのリスト。 initiatorの配列

要求例

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

{
  "id": 6683,
  "method": "ModifyInitiators",
  "params": {
    "initiators": [
      {
        "initiatorID": 2,
        "alias": "alias1",
        "volumeAccessGroupID": null
      },
      {
        "initiatorID": 3,
        "alias": "alias2",
        "volumeAccessGroupID": 1
      }
    ]
  }
}

応答例

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

{
  "id": 6683,
  "result": {
    "initiators": [
      {
        "alias": "alias1",
        "attributes": {},
        "initiatorID": 2,
        "initiatorName": "iqn.1993-08.org.debian:01:395543635",
        "volumeAccessGroups": []
      },
      {
        "alias": "alias2",
        "attributes": {},
        "initiatorID": 3,
        "initiatorName": "iqn.1993-08.org.debian:01:935573135",
        "volumeAccessGroups": [
          1
        ]
      }
    ]
  }
}

新規導入バージョン

9.6