Modèle d'interface
Cette section décrit les opérations ci-dessous prises en charge au niveau du modèle d'interface :
nfa1000
Cette section décrit les opérations ci-dessous prises en charge au niveau du modèle d'interface :
Ajouter un modèle d'interface
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate
Méthode
POST
Charge utile
{"name": "<Enter the Interface template Name>", "nameTemplate": "<Enter valid Interface name>","descriptionTemplate": "<Enter Valid Interface Description>"}
Les valeurs nameTemplate et descriptionTemplate suivantes sont valides :
- [DeviceAlias]: indique le nom alternatif de l'unité.
- [DeviceName]: indique le nom de l'unité.
- [ifType]: indique le type de la construction If.
- [ifIndex]: indique l'index de la construction If.
- [portName]: indique le nom du port.
- [ifName]: indique le nom de la construction If.
- [ifAlias]: indique le nom alternatif de la construction If.
- [ifDescr]: indique la description de la construction If.
Vous pouvez également entrer plusieurs valeurs nameTemplate et descriptionTemplate en les séparant par un symbole |.
Exemple 1 : ajout d'une seule valeur
Exemple de demande
Cet exemple illustre une valeur unique pour les propriétés name, nameTemplate et descriptionTemplate.
http://127.0.0.1:8981/odata/api/interfaceTemplate
Exemple de charge utile
{"name": "test sample 3", "nameTemplate": "[ifIndex]","descriptionTemplate": "[ifIndex]"}
Exemple de réponse
Une nouvelle propriété templateId est créée pour les exemples de valeurs de paramètre de charge utile.
{"@odata.context": "$metadata#interfaceTemplate","templateId": 19,"name": "test sample 3","nameTemplate": "[ifIndex]","descriptionTemplate": "[ifIndex]"}
Exemple 2 : ajout de plusieurs valeurs
Exemple de demande
Cet exemple illustre plusieurs valeurs pour les propriétés nameTemplate et descriptionTemplate.
http://127.0.0.1:8981/odata/api/interfaceTemplate
Exemple de charge utile
{"name": "test sample 4", "nameTemplate": "[ifType|ifIndex]", "descriptionTemplate": "[ifType|ifIndex]" }
Exemple de réponse
Une nouvelle propriété templateId est créée pour les exemples donnés de valeurs de paramètre de charge utile.
{"@odata.context": "$metadata#interfaceTemplate","templateId": 20,"name": "test sample 4","nameTemplate": "[ifType|ifIndex]","descriptionTemplate": "[ifType|ifIndex]"}
Modifier un modèle d'interface
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate(<Enter the template_id to be updated>)
Méthode
PATCH
Charge utile
Vous pouvez modifier uniquement les propriétés nameTemplate et descriptionTemplate pour le modèle d'interface
global-default
.Les propriétés (autres que la propriété
global-default
) que vous pouvez modifier pour un modèle d'interface sont les suivantes :{"name": "<Enter the Interface template Name>", "nameTemplate": "<Enter a valid Interface name>","descriptionTemplate": "<Enter a Valid Interface Description>"}
Les valeurs nameTemplate et descriptionTemplate suivantes sont valides :
- DeviceAlias
- DeviceName
- ifDescr
- ifAlias
- ifName
- portName
- ifIndex
- ifType
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaceTemplate(1234)
Exemple de charge utile
Dans cet exemple, les propriétés (autres que la propriété
global-default
) que vous pouvez modifier pour un modèle d'interface sont les suivantes :{"name": "test123376", "nameTemplate": "[ifmapid]", "descriptionTemplate": "[ifmapid]" }
Exemple de réponse
Cette API ne renvoie aucune réponse.
Supprimer un modèle d'interface
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaceTemplate(<Enter the template_id to be deleted>)
Méthode
DELETE
Vous ne pouvez pas supprimer les propriétés du modèle d'interface
global-default
.Exemple de demande
http://127.0.0.1:8981/odata/api/interfaceTemplate(123)
Exemple de charge utile
{"interfaceTemplate":[123]}
Exemple de réponse
Cette API ne renvoie aucune réponse.