REST Public API
The FOXMAN‑UN provides a number of REpresentational State Transfer (REST) resources of the ENP on a public API. This public API is based on the Swagger UI. It is used to manage some of the Ethernet Networking Package (ENP) related information.
To make use of this interface you need a web browser and the IP address of the FOXMAN‑UN server. To access the information provided, start the web browser and enter the following URL in the address field:
https://<IP_address>:<public-rest-port>/public-ui/index.html
where:
• <IP_address> is the IP address of the FOXMAN‑UN server,
• <public-rest-port> is 9443 (default value).
Example:
https://10.6.114.32:9443/public-ui/index.html
Some browsers consider the connection to this URL not secure due to the self-signed certificate used. Depending on the browser type and version, this may require you to add a security exception for being able to use the REST Public API.
The basic operations supported are “Get”, “Post”, and “Delete”. The following resources are available:
Resource (URL) | Description | Result |
|---|---|---|
GET: | ||
/network/nes | List of all Network Elements. | network.nes.json |
/network/nes?name=NE_12.0.120.17 ?ipAddress=12.0.120.17 | List of Network Elements with the specified name. Wildcards are not supported. | |
/network/nes/{NEid} | Return a particular Network Element with the specified NEid. | |
/enp/nes | List of all Network Elements in the ENP domain | enp.nes.json |
/enp/nes?name=NE_12.0.120.17 | List of Network Elements with the specified name present in the ENP domain. | |
?ipAddress=12.0.120.17 | List of Network Elements with the specified IP Address. | |
?nodeId=82 | List of Network Elements with the specified ENP Node ID. | |
?globalId=2000 | List of Network Elements with the specified ENP Global ID. | |
Wildcards are not supported. Several parameters are treated as AND. | ||
/enp/nes/{NEid} | Return a particular Network Element in the ENP domain with the specified NEid. | |
/enp/tunnels | List of all ENP tunnels. | enp.tunnels.json |
/enp/tunnels?name=DMEO_VPLS_222 | List of ENP tunnels with the specified name. Wildcards are not supported. | |
/enp/tunnels?tunnelIdString=8::2000::80::2000::82 | List of ENP tunnels with the specified Id that is shown in the FOXMAN‑UN Client. Wildcards are not supported. | |
/enp/tunnels?neId=3 | List of ENP tunnels with the specified NE as an Initiator or a Terminator. | |
/enp/tunnels?neId=1&neId=3 | List of ENP tunnels between the specified NEs. Any NE can be an Initiator or a Terminator. | |
/enp/tunnels/{id} | Return a particular ENP tunnel object with the specified tunnel database id. | |
/enp/tunnels/{id}/workingLSP | Get LSP information for the working path (id=1). | enp.lsp.json |
/enp/tunnels/{id}/protectingLSP | Get LSP information for the protecting path (id=2). | |
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements | Return the list of all running or finished delay measurement tasks | |
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements/{taskId} | Return results of the {taskId} delay measurement task. | No statistic (min, max, avr.) is returned. |
In contrast to the core, the results of the task will not be discarded on the first retrieval and will be kept in cash until the service is restarted or cache is cleared (see below). | Only the results per each measurement (as the core does) + a timestamp when the task was originally started. | |
POST: | ||
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements | Starts new delay measurement task for the specified tunnel {id} on the workingLSP. | JSON request body { startingOn={"Initiator";"Terminator"}, timeout=5,interval=1,packetCount=5,EXPValue=0 } If any or all attributes are missing, the default values from the NEM Client (Initiator;5;1;5;0) are used. PacketCount is ignored in case of “continuous” measurement. |
/enp/tunnels/{id}/protectingLSP/oam/delaymeasurements | Starts new delay measurement task for the specified tunnel {id} on the protectingLSP. | Delay measurement taskId is returned as URL in the “location” Header, as well as in the response Body: {“taskId”: 1, Location: “/enp/tunnels/…/1”} |
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements/continuous | Start continues delay measurement process on aEnd & workingLSP. | |
DELETE: | ||
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements/{taskId} | Cancel a particular {taskId} delay measurement task. | |
/enp/tunnels/{id}/workingLSP/oam/delaymeasurements | Cancel all delay measurement tasks running for the particular tunnel+LSP. |