インターフェース テンプレート
このセクションでは、インターフェース テンプレートでサポートされている以下の操作について説明します。
nfa1000
このセクションでは、インターフェース テンプレートでサポートされている以下の操作について説明します。
インターフェース テンプレートの追加
リソース URI
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate
メソッド
POST
ペイロード
{"name": "<Enter the Interface template Name>", "nameTemplate": "<Enter valid Interface name>","descriptionTemplate": "<Enter Valid Interface Description>"}
: nameTemplate と descriptionTemplate の有効な値のリストは以下のとおりです。
- [DeviceAlias]: デバイスの代替名を示します。
- [DeviceName]: デバイス名を示します。
- [ifType]: If タイプを示します。
- [ifIndex]: If インデックスを示します。
- [portName]: ポート名を示します。
- [ifName]: If 名を示します。
- [ifAlias]: If 代替名を示します。
- [ifDescr]: If の説明を示します。
また、nameTemplate と descriptionTemplate の複数の値を | 記号で区切って入力することもできます。
例 1: 単一の値の追加
サンプル リクエスト
この例は、name、nameTemplate、および descriptionTemplate の単一の値を示しています。
http://127.0.0.1:8981/odata/api/interfaceTemplate
サンプル ペイロード
{"name": "test sample 3", "nameTemplate": "[ifIndex]","descriptionTemplate": "[ifIndex]"}
サンプル レスポンス
新しい templateId が、サンプル ペイロード パラメータ値に対して作成されます。
{"@odata.context": "$metadata#interfaceTemplate","templateId": 19,"name": "test sample 3","nameTemplate": "[ifIndex]","descriptionTemplate": "[ifIndex]"}
例 2: 複数の値の追加
サンプル リクエスト
この例は、nameTemplate と descriptionTemplate の複数の値を示しています。
http://127.0.0.1:8981/odata/api/interfaceTemplate
サンプル ペイロード
{"name": "test sample 4", "nameTemplate": "[ifType|ifIndex]", "descriptionTemplate": "[ifType|ifIndex]" }
サンプル レスポンス
新しいテンプレート ID が、指定したサンプル ペイロード パラメータ値に対して作成されます。
{"@odata.context": "$metadata#interfaceTemplate","templateId": 20,"name": "test sample 4","nameTemplate": "[ifType|ifIndex]","descriptionTemplate": "[ifType|ifIndex]"}
インターフェース テンプレートの編集
リソース URI
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate(<Enter the template_id to be updated>)
メソッド
PATCH
ペイロード
:
グローバルなデフォルト
のインターフェース テンプレートに対する nameTemplate プロパティと descriptionTemplate プロパティのみを編集できます。グローバルなデフォルト
以外のインターフェース テンプレートに対して編集できるプロパティは、以下のとおりです。{"name": "<Enter the Interface template Name>", "nameTemplate": "<Enter a valid Interface name>","descriptionTemplate": "<Enter a Valid Interface Description>"}
: nameTemplate と descriptionTemplate の有効な値のリストは以下のとおりです。
- DeviceAlias
- DeviceName
- ifDescr
- ifAlias
- ifName
- portName
- ifIndex
- ifType
サンプル リクエスト
http://127.0.0.1:8981/odata/api/interfaceTemplate(1234)
サンプル ペイロード
このサンプルでは、
グローバルなデフォルト
以外のインターフェース テンプレートに対して編集できるプロパティは以下のとおりです。{"name": "test123376", "nameTemplate": "[ifmapid]", "descriptionTemplate": "[ifmapid]" }
サンプル レスポンス
この API に対するレスポンスはありません。
インターフェース テンプレートの削除
リソース URI
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate(<Enter the template_id to be deleted>)
メソッド
DELETE
:
グローバルなデフォルト
のインターフェース テンプレートに対するプロパティは削除できません。サンプル リクエスト
http://127.0.0.1:8981/odata/api/interfaceTemplate(123)
サンプル ペイロード
{"interfaceTemplate":[123]}
サンプル レスポンス
この API に対するレスポンスはありません。