ModifyInitiators

您可以使用 ModifyInitiators 方法更改一个或多个现有启动程序的属性。

您不能更改现有启动程序的名称。如果需要更改启动程序的名称，请先使用 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