VM マネージャーの取得

インフラストラクチャー内で定義されている VM マネージャーに関する情報を取得するには、api/sam/vmmanagers エレメントに対して GET操作を使用します。API は、VM Manager パネルで使用できるデータと同じデータを返します。maxVMManagerVisibility で許可された値よりも長く情報をレポートしない VM Manager は、API によって返されません。

この REST API では、ユーザー・インターフェースで表示される情報よりも多くの情報が返されます。この場合、集中モードと分散モードの両方で管理される VM マネージャーに関する情報が返されます。また、RHV-M を使用しない Xen や KVM などの VM マネージャーへの接続を定義する必要のない仮想化テクノロジーからの情報を返します。データを収集する VM マネージャーの範囲は、割り当てられたコンピューター・グループに属するコンピューターにインストールされている VM マネージャー・ツールに応じて異なります。

必要な許可: VM マネージャーに関する情報を取得するには、「VM マネージャーとサーバーの管理」権限が必要です。

表 1. 操作の説明
操作の詳細 説明
操作 GET /api/sam/vmmanagers
目的 VM マネージャーのリストを返します。
HTTP メソッド GET
リソース 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 tool が BigFix Inventory データベースに定義されていない場合

メッセージの本文にはエラー・メッセージと詳細が含まれます。

応答属性

表 2. 応答属性とその有効な値
属性 指定可能な値
lastcollection データが VM マネージャーから収集された日時。
deleted BigFix Inventory から VM マネージャーが削除されたかどうかを示します。
lastmodified VM マネージャーが最後に変更された日時。
login VM マネージャーにアクセスするのに使用するユーザー名。
protocol VM マネージャーで使用される通信プロトコル。この属性は、Hyper-V にのみ適用できます。
  • 0 - WinRM
  • 1 - PowerShell
  • Null - VM マネージャーが Hyper-V ではない
sharedcredentials VM マネージャーが、同じクラスター内の他のホストと資格情報を共有するかどうかを示します。この属性は、Hyper-V にのみ適用できます。
status VM マネージャーのステータス。
  • -1 - 無効な資格情報 - 中断
  • 0 - 保留中
  • 1 - OK
  • 2 - 接続が失敗しました
  • 3 - 無効な資格情報 - 試行中
  • 6 - 重複するアドレス
  • 7 - ハード・タイムアウト - 中断
  • 8 - OK - 重複する UUID は破棄されました
  • 9 - VM マネージャー・データがありません
  • 98 - 非アクティブ
  • 99 - 不明な問題
各状況について詳しくは、以下を参照してください。VM マネージャーの状況。
type VM マネージャーのタイプ。
  • 1 - Hyper-V
  • 2 - VMware vSphere または VMware ESX
  • 3 - RHV-M
  • 9.2.12 4 - Citrix Hypervisor (旧称 XenServer)
  • 99 - その他。この値は、VM マネージャーで、RHV-M がない Xen や KVM など、「仮想化ホストでのキャパシティー・スキャンの実行」タスクを使用してどのデータを収集するかを指定するために使用します。
url VM マネージャーの Web アドレス。
vmmanagerid VM マネージャーの ID。
vmmanagertoolid 特定の VM マネージャーから情報を収集する VM Manager toolの ID。

HTTP 会話の例

要求
GET http://localhost:9081/api/sam/vmmanagers
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
応答の本文 (JSON)
[{
    "vmmanagerid":1,
    "protocol":null,
    "deleted":false,
    "vmmanagertoolid":1,
    "sharecredentials":false,
    "lastmodified":"2016-06-12 09:06:51.723",
    "login":"admin@internal",
    "type":3,
    "url":"https:\/\/9.156.44.146:8443\/api",
    "status":98
}]