IP アドレスの取得 (v2)

9.2.12 から使用可能です。インフラストラクチャー内のコンピューターの IP アドレスに関する情報を要求するには、api/sam/v2/detailed_hw_ip_addresses エレメントに対して GET 操作を使用します。

権限

ユーザーこの API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。

リソース URL

https://hostname:port/api/sam/v2/detailed_hw_ip_addresses?token=token

リソース情報

表 1. リソース情報
操作の詳細	「説明」
HTTP メソッド	`GET`
要求ヘッダー	ヘッダー `Accept-Language` (オプション) 値 en-US (英語のみをサポート) 応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求フォーマット	`application/json`
応答ヘッダー	ヘッダー `Content-Type` 値 `application/json` 応答のコンテンツ・タイプを指定します。
応答ヘッダー	ヘッダー `Content-Language` 値 en-US, … 応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード	`IP Addresses` element
応答フォーマット	`application/json`
応答コード	`200 – OK` `500 – "Bad Request"` 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

スキーマの説明

この REST API によって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。

GET api/sam/v2/schemas/detailed_hw_ip_address.json?token=token

選択可能な列

スキャンされたシステム上の IP アドレスに関連する属性のリスト。取得されたアドレスは、 ipv6_address 属性を除いて IPv4 形式になっています。

出力には、このグループの各属性の複数のインスタンスが含まれる可能性があります。

表 2. IP アドレスに関する情報が含まれる列
プロパティー	説明\n	タイプ
ID	レコードの ID。	Integer
computer_id	BigFix Inventory データベースで指定されているコンピューターの ID。	Integer
updated_at	現在の情報が BigFix Inventory にインポートされた日時。	ストリング
address	コンピューターの IP アドレス。	ストリング
hostname	指定された IP を持つコンピューターのホスト名。	ストリング
primary_dns	プライマリー・ドメイン・ネーム・システム (DNS) 。	ストリング
permanent_mac_address	指定された IP アドレスに関連付けられた永続的メディア・アクセス制御 (MAC) アドレス。	ストリング
ipv6_address	バージョン 6 の IP アドレス。	ストリング

照会パラメーター

表 3. 照会パラメーター
パラメーター	「説明」	必須	値
columns[]	取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。例: コンピューター ID の取得: `URL?columns[]=computer_id`		ストリング
order	返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に `desc` を追加します。例: コンピューター ID の降順での並び替え: `URL?order[]=computer_id desc`		ストリング
限界値	取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。例: 100 件のレコードの取得 `URL?limit=100` 注: デフォルトでは、この API の limit パラメーターは 100000 に設定されています。		数字
offset	結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。例: レコード 150 の後から始まる 50 件のレコードの取得 `URL?limit=50&offset=150`		数字
token	固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。	✓	英数字
criteria	特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。 `<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> <criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace> <boolean-operator> ::= "and" \| "or" <criterion> ::= <criteria> \| <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket> <column> ::= <json-string> <operator> ::= <json-string> <value> ::= <json-array> \| <json-string> \| <json-numver> \| <json-null>` 演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。例: コンピューター ID が1000より大きいコンピューターの取得。 `URL?criteria={"and":[["computer_id", ">", "1000"]]}` 日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、`last` または `next` を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。		ストリング

会話例 - デフォルトの列

要求

GET /api/sam/v2/detailed_hw_ip_addresses?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

応答本文

[{
"id":1
"computer_id":1,
"updated_at":"2018-05-16T14:37:08Z",
"address":"9.174.39.183",
"hostname":"NC9174039183",
"primary_dns":"9.20.136.11",
"permanent_mac_address":"00:50:56:94:7C:95",
"ipv6_address":"fe80:0000:0000:0000:44a3:f150:0968:869e%2"
}]

会話例 - 選択された列