Interface virtuelle personnalisée
Cette section décrit les opérations suivantes prises en charge sur une interface virtuelle personnalisée.
nfa1000
Cette section décrit les opérations suivantes prises en charge sur une interface virtuelle personnalisée.
Ajouter une interface virtuelle personnalisée
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces/com.ca.nfa.odata.createCustomVirtualInterface
Méthode
POST
Charge utile
{ "InterfaceId" : <Enter a valid ID>, "Name" : "<Name of the Interface Aggregation>", "Description" : "<Description of the interface Aggregation>", "IfType" : "<Custom Virtual Interface Type>", "InSpeed" : <Inspeed value> , "OutSpeed" : <Outspeed Value>, "Subnet" :<Subnet value> }
Exemple 1 : ajout d'un sous-réseau unique
Exemple de demande
Création d'une interface virtuelle personnalisée avec un sous-réseau unique :
http://127.0.0.1:8981/odata/api/interfaces/com.ca.nfa.odata.createCustomVirtualInterface
Méthode
POST
Exemple de charge utile
{"InterfaceId" : 11,"Name" : "testCVI","Description" : "CVI","IfType" : "WAN","InSpeed" : 10 ,"OutSpeed" : 11 ,"Subnet" :["10.0.0.4/22"]}
Exemple de réponse :
{"@odata.context": "$metadata#Collection(com.ca.nfa.odata.interfaces)","value": [{"ID": 537,"AgentType": "Virtual","RouterAddress": "127.0.0.1","Description": "CVI","InSpeed": 10,"OutSpeed": 11,"IfIndex": 0,"PersistentIfIndex": 2147483729,"IfType": "WAN","UpdatedOn": 1546247778,"Enabled": "Y","LastData": 0,"HarvesterAddress": "127.0.0.1","Name": "testCVI"}]}
Exemple 2 : ajout de plusieurs sous-réseaux
Exemple de demande
Création d'une interface virtuelle personnalisée avec plusieurs sous-réseaux :
http://127.0.0.1:8981/odata/api/interfaces/com.ca.nfa.odata.createCustomVirtualInterface
Méthode
POST
Exemple de charge utile
{ "InterfaceId" : 12, "Name" : "testCVI1", "Description" : "CVI", "IfType" : "WAN", "InSpeed" : 10 , "OutSpeed" : 11 , "Subnet" :[ "10.0.0.4/22", "10.0.0.9/3", "10.0.0.9/22" ] }
Exemple de réponse :
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.interfaces)", "value": [ { "ID": 11, "AgentType": "Virtual", "RouterAddress": "127.0.0.1", "RouterId": null, "Description": "CVI", "InSpeed": 1391671, "OutSpeed": 14393, "IfIndex": 0, "PersistentIfIndex": 2147483653, "IfType": "WAN-ATM", "UpdatedOn": 1603098194, "Enabled": "N", "LastData": 0, "HarvesterAddress": "127.0.0.1", "Name": "testCVI", "TrafficStatus": null, "DomainId": null, "DomainName": null, "Subnet": [], "ComponentAgentIds": [] } ] }
Obtenir l'interface virtuelle personnalisée
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$filter= contains(AgentType,'Virtual')
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces?$filter= contains(AgentType,'Virtual')
Méthode
GET
Exemple de réponse :
{ "@odata.context": "http://localhost:8981/odata/api/$metadata#interfaces(ID,AgentType,RouterAddress,Description,InSpeed,OutSpeed,IfIndex,PersistentIfIndex,IfType,UpdatedOn,Enabled,LastData,HarvesterAddress,Name,TrafficStatus,DomainId,DomainName,Subnet,ComponentAgentIds)", "value": [ { "InSpeed": 2000000, "IfType": "WAN", "Description": "interface updatemani", "PersistentIfIndex": 2147483650, "Enabled": "Y", "RouterAddress": "10.0.40.33", "Name": "Interface -edit apimani", "AgentType": "Virtual", "DomainId": 1, "LastData": 0, "OutSpeed": 20000000, "IfIndex": 0, "UpdatedOn": 1600937363, "ID": 185, "HarvesterAddress": "10.74.241.110", "TrafficStatus": "Red", "DomainName": "Default Domain", "Subnet": [ "1.1.1.0/24" ], "ComponentAgentIds": [], } ], }
Modifier l'interface virtuelle personnalisée
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(<CustomVirtualInterface_ID>)
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(185)
Méthode
PATCH
Exemple de charge utile
{ "Name": "Interface-edit2", "Subnet": [ "1.1.1.0/24", "10.10.10.10/24" ] }
Exemple de réponse
Cette API ne renvoie aucune réponse.
Supprimer l'interface virtuelle personnalisée
Les interfaces virtuelles personnalisées peuvent être supprimées à l'aide des API de suppression d'interfaces existantes. Pour plus d'informations, consultez les API suivantes :