Routeurs
Cette section décrit les opérations prises en charge suivantes sur les routeurs :
nfa1000
Cette section décrit les opérations prises en charge suivantes sur les routeurs :
Modifier un routeur unique
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers(PropertyRef Name value)
Méthode
PATCH
Charge utile
{"snmpVersion": <snmp version value>,"snmpPort": <snmp portvalue>,"routerName": "<Router name>","templateId": <template ID value>"domainID": <domainID value>"profileId": <profile ID value>}
- Les valeurs snmpVersion valides sont 1, 2 ou 3.
- Entrez un ID de modèle supérieur ou égal à 1.
Exemple de demande
http://127.0.0.1:8981/odata/api/routers(1500004)
Exemple de charge utile
{"snmpVersion": 2,"snmpPort": 123,"routerName": "127.0.0.1","templateId": 5"domainID": 1"profileId": 5}
Exemple de réponse
Cette API ne renvoie aucune réponse.
Modifier des routeurs en bloc
Cette API permet de mettre à jour les valeurs de plusieurs entités à la fois lorsque celles-ci possèdent des propriétés similaires.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers/com.ca.nfa.odata.editRouters
Méthode
POST
Charge utile
"RouterIds":[<Enter the list of Router_IDs separated by a comma>],"snmpVersion": <snmp version value>,"snmpPort" : <snmp port value>,"templateId" : <template id value>,"profileId" : <profile id value>"domainID" : <domain id value>}
Les valeurs snmpVersion valides sont 1, 2 ou 3.
Exemple de demande
http://127.0.0.1:8981/odata/api/routers/com.ca.nfa.odata.editRouters
Exemple de charge utile
{"RouterIds": [1500012,1500013],"snmpVersion": 3,"snmpPort": 1654,"templateId": 1,"profileId": 4,"domainID" :1}
Exemple de réponse
{"@odata.context": "$metadata#Collection(com.ca.nfa.odata.router)","value": [{"ID": 1500012,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 4,"snmpVersion": 3,"snmpPort": 1654,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 10,"dnsLastLookupTime": 1556273867,"dnsExpireTime": 1556878667,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1556273741,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1},{"ID": 1500013,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 0,"snmpVersion": 2,"snmpPort": 161,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 13,"dnsLastLookupTime": 1556273867,"dnsExpireTime": 1556878667,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1556273741,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}]}
Activer un routeur unique
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers(<routerID Value>)/com.ca.nfa.odata.enableRouter
Méthode
POST
Exemple de demande
http://127.0.0.1:8981/odata/api/routers(1500002)/com.ca.nfa.odata.enableRouter
Exemple de réponse
{"@odata.context": "$metadata#com.ca.nfa.odata.router","ID": 1500002,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 1552995238,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 2,"profileId": 4,"snmpVersion": 2,"snmpPort": 161,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 10,"dnsLastLookupTime": 1556194180,"dnsExpireTime": 1556798980,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1552995238,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}
Activer des routeurs en bloc
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers/com.ca.nfa.odata.enableRouters
Méthode
POST
Charge utile
"RouterIds":[<List of Router_ids separated by a comma>
Exemple de demande
http://127.0.0.1:8981/odata/api/routers/com.ca.nfa.odata.enableRouters
Exemple de charge utile
"RouterIds":[1554235706, 1554840506, 1553025868]
Exemple de réponse
{"@odata.context": "$metadata#Collection(com.ca.nfa.odata.router)","value": [{"ID": 1500001,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 0,"snmpVersion": 2,"snmpPort": 161,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 10,"dnsLastLookupTime": 1554235706,"dnsExpireTime": 1554840506,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1553025868,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}]}
Désactiver un routeur unique
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers(<routerID value>)/com.ca.nfa.odata.disableRouter
Méthode
POST
Exemple de demande
http://127.0.0.1:8981/odata/api/routers(1500002)/com.ca.nfa.odata.disableRouter
Exemple de réponse
{"@odata.context": "$metadata#com.ca.nfa.odata.router","ID": 1500002,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 1552995238,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 2,"profileId": 4,"snmpVersion": 2,"snmpPort": 161,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 10,"dnsLastLookupTime": 1556194180,"dnsExpireTime": 1556798980,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1552995238,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}
Désactiver des routeurs en bloc
Exemple d'URI
http://<nfa odata host>:<nfa odata port>/odata/api/routers/com.ca.nfa.odata.disableRouters
Méthode
POST
Charge utile
"RouterIds":[<List of router_ids separated by a comma>]
Exemple de demande
http://127.0.0.1:8981/odata/api/routers/com.ca.nfa.odata.disableRouters
Exemple de charge utile
"RouterIds":[150032,123894,222891,100034]
Exemple de réponse
{"@odata.context": "$metadata#Collection(com.ca.nfa.odata.router)","value": [{"ID": 1500001,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 0,"snmpVersion": 2,"snmpPort": 161,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 10,"dnsLastLookupTime": 1554235706,"dnsExpireTime": 1554840506,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1553025868,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}]}
Supprimer un routeur unique
Cette API vous permet de supprimer un seul routeur.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers(<router_id>)
Méthode
DELETE
En-têtes HTTP
Content-Type:application/json; odata.metadata=minimal
Parameters (Paramètres)
Le tableau ci-dessous inclut les paramètres obligatoires.
Parameters (Paramètres) | Description |
|---|---|
router_id | Indique l'ID de routeur que vous souhaitez supprimer d'un ensemble d'entités de routeur. |
Exemple de demande
La demande suivante illustre l'opération de suppression de l'ID de routeur 1500002.
http://127.0.0.1:8981/odata/api/routers(1500002)
Exemple de réponse
Cette API ne renvoie aucune réponse.
Supprimer des routeurs en bloc
Le code suivant est une section de métadonnées de référence pour une action de suppression de plusieurs routeurs.
URI de la ressource
http://<nfa odata host>:<nfa odata port>/odata/api/routers/com.ca.nfa.odata.deleteRouters
Méthode
POST
Charge utile
"RouterIds":[1500008,1500009]
Exemple de demande
La demande suivante illustre l'opération de suppression de l'entité de suppression en bloc de routeurs.
http://127.0.0.1:8080/odata/api/routers/com.ca.nfa.odata.deleteRouters
Exemple de charge utile
"RouterIds":[150032,123894,222891,100034]
Exemple de réponse
{"@odata.context": "$metadata#Collection(com.ca.nfa.odata.router)","value": [{"ID": 1500008,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 4,"snmpVersion": 1,"snmpPort": 36863,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 2,"agentCount": 0,"dnsLastLookupTime": 1556273867,"dnsExpireTime": 1556878667,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1556273741,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1},{"ID": 1500009,"routerAddress": "127.0.0.1","sysDescr": "127.0.0.1","sysName": "","deviceName": "127.0.0.1","deviceAlias": "127.0.0.1","sysUptime": 0,"lastData": 0,"lastReboot": 0,"lastRefresh": 0,"lastDiscovery": 0,"lastHarvesterUpdate": 0,"firstPollError": 0,"nextPollRetry": 0,"harvesterID": 1,"profileId": 4,"snmpVersion": 1,"snmpPort": 36863,"snmpTimeout": 3,"snmpRetry": 3,"snmpMaxRows": 10,"ifNumber": 0,"interfaceCount": 10,"agentCount": 8,"dnsLastLookupTime": 1556273867,"dnsExpireTime": 1556878667,"syncUpdateTime": 0,"routerName": null,"routerUpdatedOn": 1556273741,"templateId": 1,"snmpProxyAddress": "127.0.0.1","dnsProxyAddress": "127.0.0.1","tenantId": 8,"domainID": 1}]}