共有ディスクの取得 (v2)

9.2.12 から使用可能です。 インフラストラクチャー内の共有ディスクに関する情報を要求するには、api/sam/v2/shared_disks エレメントに対して GET 操作を使用します。

前提条件

REST API を使用して共有ディスクに関する情報を取得する前に、インフラストラクチャー内の共有ディスクを検出してください。詳しくは、下記を参照してください。ステップ 1: リモート共有ディスクの検出。

権限

ユーザー この API を使用するには、「共有ディスクの表示」権限が必要です。

リソース URL

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

リソース情報

表 1. リソース情報
操作の詳細 「説明」
HTTP メソッド GET
要求ヘッダー
ヘッダー
Accept-Language (オプション)
値
en-US (英語のみをサポート)

応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求フォーマット application/json
応答ヘッダー
ヘッダー
Content-Type
値
application/json

応答のコンテンツ・タイプを指定します。
ヘッダー
Content-Language
値
en-US, …

応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
応答ペイロード Shared Disks element
応答フォーマット application/json
応答コード

200 – OK

403 – “Forbidden” ユーザーにこのアクションの実行が許可されていない場合

500– “Bad Request” 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

スキーマの説明

この REST API によって返されるすべての列のリストをその説明と一緒に取得するには、次の要求を使用します。
GET api/sam/v2/schemas/shared_disk.json?token=<token>

選択可能な列

表 2. 選択可能な列
列 「説明」 デフォルトで表示 タイプ
ID 共有ディスク・インスタンスの ID。 ✓ Integer
状況 共有ディスク・インスタンスをスキャンするように指定されたコンピューターの状況を示します。指定可能な値は以下のとおりです。
  • 0 - 共有ディスクを検出
  • 1 - 子共有ディスク
  • 2 - コンピューターの指定中
  • 3 - ソフトウェア・スキャンの待機中
  • 4 - OK
  • 5 - 新規最上位ディレクトリーの指定中
  • 6 - 新規コンピューターの指定中
  • 7 - 新しく指定されたコンピューターのソフトウェア・スキャンを待機中
 ✓ Integer
parent_id 共有ディスク・インスタンスの親の ID。 ✓ Integer
top_level 共有ディスクが共有ディスク構造内の最上位ディレクトリかどうかを示します。指定可能な値は以下のとおりです。
  • 0 - ディレクトリーは最上位ではない
  • 1 - ディレクトリーは最上位である
 ブール値
exported_directory 共有ディスクのエクスポート・ディレクトリー。 ✓ ストリング
type 共有ディスクのタイプ。指定可能な値は以下のとおりです。
  • 0 - ネットワーク・ファイル・システム
  • 1 - Samba ファイル・システム
 ✓ Integer
computers_count 共有ディスクがマウントされているコンピューターの数。 ✓ Integer

適用可能な関連付け

以下の関連付けからデータを追加で取得できます。

照会パラメーター

表 3. 照会パラメーター
パラメーター 「説明」 必須 値
columns[] 取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。
例: 製品名とリリースの取得
URL?columns[]=product_name&columns[]=product_release
 ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。
例: コンピューター ID の降順での並び替え
URL?order[]=computer_id desc
 英数字
限界値 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。
例: 100 件のレコードの取得 
URL?limit=100
 数字
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-number> | <json-null>

演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。

例: 製品名に「BigFix」が含まれているか、ディスカバリー開始が特定の日付範囲内であるソフトウェア・インスタンスの取得 
URL?criteria={ "or": [ ["product_name", "contains", "BigFix"], 
{ "and": [ ["discovery_start", ">", "1970-01-01T00:00:00+00:00Z"], 
["discovery_start", "<", "1970-01-02T00:00:00+00:00Z"] ] } ] }

日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。

例: 過去 7 日間に初めて報告されたソフトウェア・インスタンスの取得
URL?criteria={"and":[["discovery_start","last","P7D"]]}
 ストリング

会話例 - デフォルトの列

要求
GET api/sam/v2/shared_disks?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答本文
[{
"id":"5",
"status":"0"'
"type":"0"
"designated_computer_id":"29"
"parent_id":"3"
"computers_count":"10"
"exported_directory":"192.0.2.24:/file_server/tlcm/ISO/RHEL"

会話例 - すべての列

要求
GET api/sam/v2/shared_disks?columns[]=id&columns[]=status
&columns[]=parent_id&columns[]=top_level&columns[]=exported_directory
&columns[]=type&columns[]=computers_count&columns[]=designated_copmuter_id
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
応答本文
[{
"id":"1",
"status":"0",
"parent_id":"5",
"top_level":"0",
"exported_directory":"192.0.2.24:/file_server/tlcm/HOME"
"type":"0",
"computers_count":"10",
"designated_computer_id":"29"

会話例 - 関連付け

要求
GET api/sam/v2/shared_disks?columns[]=exported_directory
&columns[]=computers_count&columns[]=shared_disk_members.computer_id
&columns[]=shared_disk_members.mount_point&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答本文
[{
"exported_directory":"192.0.2.24:/file_server/tlcm/HOME",
"computers_count":"1",
"members":
    {
    "computer_id":"5",
    "mount_point":"/mnt/fs"
    }
}]