[index] AT-Vista Manager EX（AT-VST-APL版） ベースリファレンスマニュアル 3.17.0

# 各種操作 / その他の設定 / グループのプリセットの作成

「資産管理」画面では、デバイスの属性を基に「グループ」を作成できます。デバイスの属性には、IPアドレスやMACアドレス、ベンダー、デバイスファミリーなどがあります。
通常、グループの登録はAVM EXのWeb設定画面上で行いますが、多数のグループを登録する場合は、事前に作成したプリセットファイルを読み込ませることで登録作業を簡単にできます。

## プリセットファイルの作成

プリセットファイルは、次のファイルを1つにまとめてZIP（拡張子：.zip）形式、またはgzip（拡張子：.gz、.gzip）形式で圧縮したデータです。

- 定義ファイル
  登録に必要な情報をJSON形式で記述します。
- 画像ファイル
  カスタムアイコンとして使用する画像を格納します。指定できる画像の形式は、JPEG、PNG、SVG形式です。
  JPEG形式、PNG形式の場合、画像の大きさは64×64ピクセル以下にする必要があります。
  SVG形式では、元の大きさにかかわらず上記の大きさに合わせて表示します。
  画像ファイルサイズは1MBまでサポートしますが、上記のいずれの場合も、通常は1MBに達することはありません。

### 定義ファイルの記述

> Note

> > ここでは、JSON形式でのデータの表記法については説明しません。別途インターネット上の情報をご覧ください。

定義ファイルは、groupName、criteria、iconの3つのキーを持ったグループ定義オブジェクトを、配列として記述します。
定義ファイルには、一度に最大200グループまでを定義できます。
■ 例

    [
      {
        "groupName": "A-company Switches",
        "criteria": "macAddress = 001a.eb**.**** AND deviceType = Switch",
        "icon": "a-company_ip_switch.svg"
      },
      {
        "groupName": "C-company Routers",
        "criteria": "vendor contains C AND deviceType = Router",
        "icon": "c-company_router.png"
      },
      {
        "groupName": "F1-switches",
        "criteria": "ipv4Address range [ 10.38.60.1 10.38.60.128 ]",
        "icon": "switch.jpg"
      },
     {
        "groupName": "Top-priority",
        "criteria": "( hostname = switch1 AND ipv4Address = 192.168.1.1 ) OR deviceType = x550",
        "icon": "switch.svg"
      },
    ]

#### キー

グループの各キーの意味は次の通りです。

- groupName：
  グループ名を指定します。
  4～32文字の、半角および全角の英字・数字・かな・漢字・記号を使用できます。
- criteria：
  デバイスをグループメンバーと判定するための基準を指定します。
- icon：
  グループに適用するアイコンのファイル名を指定します。
  ファイル名は必ず、プリセットファイル内の、または、別途アップロードした画像ファイルのいずれかと名前が一致する必要があります。

#### 判定基準の記述

「vendor contains Allied」のように、基準となるパラメーター名、演算子、比較文字列を「パラメーター名 演算子 比較文字列」の形で半角スペースで区切って表記します。
比較文字列に半角スペースが含まれる場合は、「"Allied Telesis"」のように二重引用符で囲みます。
これらの基準をJSONの値として記述する際は、全体を二重引用符で囲む必要があります。実際にcriteriaキーの値として比較文字列を二重引用符で囲む場合は、「"criteria": "vendor contains \"Allied Telesis\""」のように、JSONの表記法に則って適切にバックスラッシュでエスケープしてください。
■ 基本の表記
判定基準の各パラメーターの意味と、使用可能な演算子（後述）は次の通りです。

表 1：判定基準パラメーター
パラメーター | 使用可能な演算子 | 説明
--- | --- | ---
hostname | =、!=、contains、in | ホスト名を指定します。
ipv4Address | =、!=、in、range | IPv4アドレス、またはアドレス範囲（後述）で指定します。
macAddress | =、!=、in | MACアドレスを指定します。大文字と小文字を区別しません。 任意とする桁は「*」として指定することができます。例えば、「0000.5e00.53**」は「00:00:5e:00:53」で始まり、末尾2オクテットは任意のMACアドレス範囲、00:00:5e:00:53:00～00:00:5e:00:53:ffを指します。
vendor | =、!=、contains、in | デバイスのMACアドレスのOUI（ベンダーコード）に基づくベンダー名（「Allied Telesis Labs Ltd」など）を指定します。 半角スペースを含む文字列を指定する場合は、二重引用符（"）で囲む必要があります。 Note 二重引用符は、JSONの表記法に則って適切にバックスラッシュでエスケープしてください。
deviceType | =、!=、contains、in | デバイスの種別（router、switch、virtual appliance、otherに加え、プラグインから通知される文字列を含む）を指定します。
deviceFamily | =、in | デバイスファミリー（x530、SE250、AR4050Sなどに加え、プラグインから通知される文字列を含む）を指定します。大文字と小文字を区別しません。
operatingSystem | =、!=、contains、in | デバイスで動作しているOSを指定します。 半角スペースを含む文字列を指定する場合は、二重引用符（"）で囲む必要があります。 Note 二重引用符は、JSONの表記法に則って適切にバックスラッシュでエスケープしてください。 Note 本パラメーターによるデバイスの判定には、別途Forescoutデバイス検疫アプライアンスを導入し、AVM EXとForescoutプラグインを介した連携を行う必要があります。連携方法については、「各種操作」/「その他の設定」/「Forescoutデバイス検疫アプライアンスとの連携」をご覧ください。
softwareLocation | =、!=、contains、in | デバイスのソフトウェア上で設定された、デバイスの所在地を指定します。 半角スペースを含む文字列を指定する場合は、二重引用符（"）で囲む必要があります。 Note 二重引用符は、JSONの表記法に則って適切にバックスラッシュでエスケープしてください。 Note 本パラメーターによるデバイスの判定には、別途Forescoutデバイス検疫アプライアンスを導入し、AVM EXとForescoutプラグインを介した連携を行う必要があります。連携方法については、「各種操作」/「その他の設定」/「Forescoutデバイス検疫アプライアンスとの連携」をご覧ください。

■ 演算子
演算子は比較の条件（一致する/しない、含まれる、など）を指定します。
演算子の前後は半角スペースで区切って表記します。
使用可能な演算子は次の通りです。

- =
  判定基準が比較文字列と完全一致することを意味します。
  例えば、ホスト名が「Device_A」であることを表す場合は、判定基準は次のように表記します。

      hostname = Device_A

- !=
  判定基準が比較文字列と完全一致しないことを意味します。
  例えば、IPv4アドレスが「192.168.1.1」ではないことを表す場合は、判定基準は次のように表記します。

      ipv4Address != 192.168.1.1

- contains
  判定基準が比較文字列を一部に含むことを意味します。
  例えば、ベンダー名に「Allied」を含むことを表す場合は、判定基準は次のように表記します。

      vendor contains Allied

  比較文字列に半角スペースが含まれる場合は、「"Allied Telesis"」のように二重引用符で囲みます。
  これらの基準をJSONの値として記述する際は、全体を二重引用符で囲む必要があります。実際にcriteriaキーの値として比較文字列を二重引用符で囲む場合は、「"criteria": "vendor contains \"Allied Telesis\""」のように、JSONの表記法に則って適切にバックスラッシュでエスケープしてください。
- in
  判定基準が次に羅列する値のいずれかに完全一致することを意味します。羅列する複数の値は、開き角カッコ・閉じ角カッコ（[ ]）の中に、半角スペース区切りで記述します。
  例えば、ホスト名が「Switch1」、「Switch2」、「Switch3」のいずれかであることを表す場合は、判定基準は次のように表記します。

      hostname in [ Switch1 Switch2 Switch3 ]

- range
  判定基準が次の範囲に入ることを意味します。範囲の開始・終了の値は、開き角カッコ・閉じ角カッコ（[ ]）の中に、半角スペース区切りで記述します。必ず範囲の開始の値より終了の値に大きい値を指定してください。
  例えば、IPv4アドレスが192.168.1.1～192.168.2.254の範囲に入ることを表す場合は、判定基準は次のように表記します。

      ipv4Address range [ 192.168.1.1 192.168.2.254 ]

■ 複数条件の指定
判定基準は「AND」または「OR」のキーワードを使用して、複数指定できます。
AND、ORの前後は半角スペースで区切って表記します。

- AND
  ANDの前後に記述した両方の条件を満たすことを意味します。
  例えば、ベンダー名に「Allied」を含み、かつ、IPv4アドレスが「192.168.1.1」ではないことを表す場合は、判定基準は次のように表記します。

      vendor contains Allied AND ipv4Address != 192.168.1.1

- OR
  ORの前後に記述したいずれか一方の条件を満たすことを意味します。
  例えば、IPv4アドレスが192.168.1.1～192.168.1.10の範囲内、または、デバイス種別がスイッチであることを表す場合は、判定基準は次のように表記します。

      ipv4Address range [ 192.168.1.1 192.168.1.10 ] OR deviceType = switch

  同じパラメーターに対する完全一致条件を連続して指定する場合などは、ORで条件を羅列するより、演算子inを使用するほうが便利です。
  例えば、次の判定基準の表記は同じものを意味します。

      hostname in [ Switch1 Switch2 Switch3 ]

      hostname = Switch1 OR hostname = Switch2 OR hostname = Switch3

3つ以上の条件を記述する際、ANDとORを併用する場合は、ANDの条件が先に処理されます。
例えば、次のような判定基準を考えます。

    ipv4Address range [ 192.168.1.1 192.168.1.10 ] AND hostname = Switch1 OR hostname = Switch2

この場合、ANDの前後が先に処理され、「IPv4アドレスが192.168.1.1～192.168.1.10の範囲内、かつ、ホスト名がSwitch1」、または、「ホスト名がSwitch2」と取り扱われます。結果、ホスト名「Switch2」のデバイスに対してはIPv4アドレスの条件は影響しません。
「IPv4アドレスが192.168.1.1～192.168.1.10の範囲内」、かつ、「ホスト名がSwitch1またはホスト名がSwitch2」として処理したい場合は、先に処理するOR条件を開きカッコ・閉じカッコで囲みます。

    ipv4Address range [ 192.168.1.1 192.168.1.10 ] AND ( hostname = Switch1 OR hostname = Switch2 )

実際には、ホスト名の完全一致条件を複数指定するよりは演算子inを使用するほうがカッコによるOR条件の優先処理は不要となり、シンプルに記述できます。

    ipv4Address range [ 192.168.1.1 192.168.1.10 ] AND hostname in [ Switch1 Switch2 ]

## プリセットファイルのアップロード

プリセットファイルの作成後は、「資産管理」画面のグループタブにある「プリセットを読み込み」ボタンから、該当のファイルを読み込むことができます。

1. 「プリセットを読み込み」ボタンをクリックします。
2. Webブラウザーのファイル選択ダイアログに従って、プリセットファイル（ZIP（拡張子：.zip）形式、またはgzip（拡張子：.gz、.gzip）形式）を選択します。

読み込み後、定義ファイルの解釈が行われ、記述されたグループ定義の書式が妥当であり、カスタムアイコンに指定された画像ファイルに不足がない場合、グループが一括登録されます。