VM マネージャーの追加または更新

VM マネージャーの追加または更新を行うには、api/sam/vmmanagers エレメントに対して PUT 操作を使用します。これらのアクションは、集中モードで管理されている VM マネージャーに対してのみ実行することができます。

VM マネージャーの追加または更新を行うには、以下の要件が満たされている必要があります。
  • 「VM マネージャーとサーバーの管理」権限が付与されている必要があります。
  • 割り当てられているコンピューター・グループに、中央 VM Manager toolがインストールされているコンピューターが含まれている必要があります。
1. 操作の説明
操作の詳細 「説明」
操作 PUT api/sam/vmmanagers
目的 新しい VM マネージャーを追加するか、既存の VM マネージャーを変更します。
HTTP メソッド PUT
リソース URI https://server_host_name:port_number/api/sam/vmmanagers?token=token
要求 Content-Type application/json
応答 Content-Type application/json
正常な HTTP 応答コード
  • 200 - OK
エラーの HTTP 応答コード
  • 400 – "Bad Request" 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合
  • 401 – "Unauthorized" ユーザーに「VM マネージャーとサーバーの管理」権限が付与されていない場合
  • 403 – "Forbidden" 中央 VM Manager toolがインストールされているコンピューターが、対象ユーザーに割り当てられているコンピューター・グループに属していない場合
  • 500 – "Internal Server Error" VM Manager toolBigFix Inventory データベースに定義されていない場合このコードには、BigFix サポートに問い合わせる必要がある不明な問題が示されている場合もあります。
注: 円記号は予約文字であり、JSONでは使用できません。文字列で使用するには適切にエスケープする必要があります。円記号\\ に置き換えます。API 内のすべてのフィールドに適用されます。

要求属性

2. 要求属性
属性 「説明」
login VM マネージャーにアクセスするのに使用するユーザー名。
password VM マネージャーにアクセスするのに使用するパスワード。このパスワードは、送信後に暗号化されます。
protocol VM マネージャーで使用される通信プロトコル。この属性は、Hyper-V にのみ適用できます。
  • 0 - WinRM
  • 1 - PowerShell
sharecredentials VM マネージャーが、同じクラスター内の他のホストと資格情報を共有するかどうかを示します。この属性は、Hyper-V にのみ適用できます。
  • true - VM マネージャーは資格情報を共有します。資格情報を指定する必要はありません。
  • false - VM マネージャーは資格情報を共有しません。
type VM マネージャーのタイプ。
  • 1 - Hyper-V
  • 2 - vCenter
  • 3 - RHV-M
  • 9.2.12 4 - Citrix Hypervisor (旧称 XenServer)
url VM マネージャーの Web アドレス。完全な URL、ホスト名、または IP アドレスを指定することができます。デフォルトの URL は仮想化タイプによって異なります。
  • vCenter
    • https://<vCenter_IP_address>/sdk/vimService.wsdl
  • RHV-M
    • https://<RHV-M_IP_address>/ovirt-engine/api
  • Hyper-V
    • https://<Hyper-V_IP_address>/wsman
vmmanagerid 変更する VM マネージャーの ID。この ID を取得するには、VM マネージャーを取得するための REST API を使用します。
vmmanagertoolid 変更する VM マネージャーからデータを収集する VM Manager toolの ID。この ID を取得するには、VM マネージャーを取得するための REST API を使用します。

HTTP 会話の例 - VM マネージャーの追加

新しい VM マネージャーを追加するには、以下の属性を指定します。
  • login
  • password
  • url
  • type
要求
PUT http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
[
    {
        "login":"user1",
        "password":"vZaW1Ve6",
        "url":"192.0.2.24",
        "type":2
    }
]
応答
200 OK

HTTP 会話の例 - VM マネージャーの変更

既存の VM マネージャーを変更するには、以下の属性を指定します。
  • login
  • password
  • url
  • type
  • vmmanagerid
  • vmmanagertoolid
重要: 変更する属性の数に関係なく、すべての属性を要求内で指定する必要があります。
要求
PUT http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
[
    {
        "vmmanagerid":1,
        "vmmanagertoolid":1,
        "login":"user1",
        "password":"vZaW1Ve6",
        "url":"192.0.2.24",
        "type":3
    }
]
応答
200 OK