Interfaces
Cette section décrit les opérations ci-dessous qui sont prises en charge sur les interfaces :
nfa1000
Cette section décrit les opérations ci-dessous qui sont prises en charge sur les interfaces :
Modifier une interface unique
Pour modifier une entité unique, utilisez la méthode HTTP PATCH pour envoyer la demande.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(PropertyRef Name value)
Méthode
PATCH
Charge utile
{ "Description": <Value>, "InSpeed" : <Value>, "OutSpeed" : <Value>, "IfType" : <Value>, "Name" : <Value>, "DomainId" : <Value> }
Exemple de demande
http://127.0.0.1:8981/odata/api/interfaces(10)
Exemple de charge utile
{ "Description":"interfaceupdate", "Name":"Interface1111", "InSpeed":100, "OutSpeed":101, "IfType":"WAN", "DomainId":1 }
Exemple de réponse
Cette API ne renvoie aucune réponse.
Modifier des interfaces en bloc
Cette API OData de CA NFA permet de mettre à jour les valeurs de plusieurs entités à la fois lorsque celles-ci possèdent des propriétés similaires.
Cette API de modification en bloc est applicable uniquement pour quelques propriétés de la section Interfaces.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces/com.ca.nfa.odata.editInterfaces
Méthode
POST
Charge utile
{ "InterfaceIds":[<List of Interface_ID s separated by a comma>], "InSpeed" : <value>, "OutSpeed": <value>, "IfType" : <value>, "DomainId": <value> }
Exemple de demande
http://127.0.0.1:8981/odata/interfaces/com.ca.nfa.odata.editInterfaces
Exemple de charge utile
{ "InterfaceIds":[943,944], "InSpeed":100, "OutSpeed":100, "IfType":"WAN", "DomainId":3 }
Exemple de réponse
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.interfaces)", "value": [ { "ID": 943, "AgentType": "Physical", "RouterAddress": "127.0.0.1", "RouterId": 1500016, "Description": "interface Description", "InSpeed": 10000000, "OutSpeed": 1000000, "IfIndex": 4, "PersistentIfIndex": 5, "IfType": "WAN", "UpdatedOn": 1602590969, "Enabled": "N", "LastData": 1602673218, "HarvesterAddress": "10.80.89.28", "Name": "Interface 1", "TrafficStatus": null, "DomainId": 1, "DomainName": null, "Subnet": [], "ComponentAgentIds": [] }, { "ID": 944, "AgentType": "Physical", "RouterAddress": "127.0.0.1", "RouterId": 1500016, "Description": "", "InSpeed": 127, "OutSpeed": 149, "IfIndex": 6, "PersistentIfIndex": 8, "IfType": "WAN ATM AAL5", "UpdatedOn": 1602590969, "Enabled": "N", "LastData": 1602673218, "HarvesterAddress": "127.0.0.1", "Name": "Interface 6", "TrafficStatus": null, "DomainId": 10, "DomainName": null, "Subnet": [], "ComponentAgentIds": [] } ] }
Fusion d'interfaces
A l'instar de la fonction de fusion d'interfaces disponible dans la console
Network Flow Analysis
, l'API OData de CA NFA permet de fusionner deux interfaces.URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces/com.ca.nfa.odata.mergeInterfaces
Méthode
POST
Charge utile
{ "interface1" : <Interface_ID>, "interface2" : <Interface_ID>, "deleteSource" : <true/false>, "isOverLap" : <true/false> }
Paramètres
Paramètres de charge utile :
Paramètres | Description |
interface1 | Indique l'ID de la première interface tel que défini dans la table d'interfaces. |
interface2 | Indique l'ID de la deuxième interface tel que défini dans la table d'interfaces. |
deleteSource | Indique si la source doit être supprimée après la fusion. Les valeurs valides sont les suivantes :
|
isOverLap | Ce paramètre indique si les données chevauchées doivent être fusionnées. Les valeurs valides sont les suivantes :
|
Les interfaces interface1 et interface2 peuvent toutes les deux être utilisées comme source, auquel cas l'autre interface sera utilisée comme destination.
Exemple de demande
http://10.13.91.413:8981/odata/api/interfaces/com.ca.nfa.odata.mergeInterfaces
Exemple de charge utile
{ "interface1" : 46, "interface2" : 31, "isOverLap" : true, "deleteSource":false }
Exemple de réponse
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.interfaces)", "value": [ { "ID": 31, "AgentType": "Physical", "RouterAddress": "10.0.42.2", "Description": "edge network", "InSpeed": 1000000000, "OutSpeed": 1000000000, "IfIndex": 4, "PersistentIfIndex": 7, "IfType": "LAN-ET", "UpdatedOn": 1551158203, "Enabled": "Y", "LastData": 1551344433, "HarvesterAddress": "10.238.80.99", "Name": "Fa1/1" }, { "ID": 46, "AgentType": "Physical", "RouterAddress": "10.0.42.3", "Description": "", "InSpeed": 1000000000, "OutSpeed": 1000000000, "IfIndex": 4, "PersistentIfIndex": 6, "IfType": "LAN-ET", "UpdatedOn": 1551158203, "Enabled": "Y", "LastData": 1551189619, "HarvesterAddress": "10.238.80.99", "Name": "Fa1/1" } ] }
Supprimer une interface unique
Cette API permet de supprimer une seule interface.
L'API permet de supprimer une interface unique ainsi que l'agrégation d'interface.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(<interface_id>)
Méthode
DELETE
Parameters
Le tableau ci-dessous inclut les paramètres obligatoires.
Paramètres | Description |
|---|---|
interface_id | Indique l'ID de l'interface que vous souhaitez supprimer de l'ensemble d'entités Interfaces. |
Exemple de demande
La demande suivante illustre l'opération de suppression de l'ID d'interface 3051.
http://127.00.1:8981/odata/api/interfaces(3051)
Exemple de réponse
Cette API ne renvoie aucune réponse.
Supprimer des interfaces en bloc
L'API permet de supprimer plusieurs agrégations d'interface à la fois.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces/com.ca.nfa.odata.deleteInterfaces
Méthode
POST
Charge utile
{ "InterfaceIds":[<Enter the list of Interface_ids separated by a comma>] }
Sample Request
L'appel suivant illustre l'opération de suppression en bloc des entités Interface.
http://127.00.1:8981/odata/api/interfaces/com.ca.nfa.odata.deleteInterfaces
Exemple de charge utile
{ "InterfaceIds" : [123,402] }
Exemple de réponse
{ "@odata.context": "$metadata#Collection(com.ca.nfa.odata.interfaces)", "value": [ { "ID": 123, "AgentType": "Physical", "RouterAddress": "127.0.0.1", "Description": "Device209", "InSpeed": 1000000000, "OutSpeed": 1000000000, "IfIndex": 1, "PersistentIfIndex": 1, "IfType": "LAN-ET", "UpdatedOn": 1544529750, "Enabled": "Y", "LastData": 1546937182, "HarvesterAddress": "127.0.0.1", "Name": "Device209" }, { "ID": 402, "AgentType": "Physical", "RouterAddress": "127.0.0.1", "Description": "127.0.0.1", "InSpeed": 0, "OutSpeed": 0, "IfIndex": 7, "PersistentIfIndex": 4, "IfType": "WAN", "UpdatedOn": 1544598925, "Enabled": "Y", "LastData": 1545139819, "HarvesterAddress": "127.0.0.1", "Name": "127.0.0.1" } ] }