...
The AddIP method aggregates a new IP to the list of existing addresses of the specific interface. It accepts both ipv4 and ipv6 addresses.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/addIP | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to add the IP address and the IPProtocolEndpoint, containing the new address to be added in the logical device. |
| Return | - |
Body Example
Following example would add 192.168.1.112/24 address to interface fe-0/3/3.1
...
The AddIPv4 method aggregates a new IP to the list of existing addresses of the specific interface. It accepts ipv4 addresses only.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/addIPv4 | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to add the IPv4 address and the IPProtocolEndpoint, containing the new ipv4 address to be added in the logical device. |
| Return | - |
Body Example
Following example would add 192.168.1.112/24 address to interface fe-0/3/3.1
...
The AddIPv6 method aggregates a new IP to the list of existing addresses of the specific interface. It accepts ipv6 addresses only.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/addIPv6 | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to add the IPv6 address and the IPProtocolEndpoint, containing the new ipv6 address to be added in the logical device. |
| Return | - |
Body Example
Following example would add 2067:f0d0:1002:51::4/32 address to interface fe-0/3/3.1
...
The RemoveIP method deletes an existing IP of the list of addresses of the specific interface. It accepts both ipv4 and ipv6 addresses.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/removeIP | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to remove the IP address and the IPProtocolEndpoint, containing the ip address to be removed from the logical device. |
| Return | - |
Body Example
Following example would remove 192.168.1.112/24 address from interface fe-0/3/3.1
...
The RemoveIPv4 method deletes an existing IP of the list of ipv4 addresses of the specific interface. It accepts only ipv4 addresses.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/removeIPv4 | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to remove the IPv4 address and the IPProtocolEndpoint, containing the ipv4 address to be removed from the logical device. |
| Return | - |
Body Example
Following example would remove 192.168.1.112/24 address from interface fe-0/3/3.1
...
The RemoveIPv6 method deletes an existing IP of the list of ipv6 addresses of the specific interface. It accepts only ipv6 addresses.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/removeIPv6 | |
| Method | POST | |
| Body Parameter | SetIPAddressRequest | IpAddressRequest, containing the LogicalDevice where to remove the IPv6 address and the IPProtocolEndpoint, containing the ipv6 address to be removed from the logical device. |
| Return | - |
Body Example
Following example would remove 2607:f0d0:1002:51::4/32 address from interface fe-0/3/3.1
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<setIpAddressRequest>
<ipProtocolEndpoint>
<IPv6Address>2607:f0d0:1002:51::4</IPv6Address>
<prefixLength>32</prefixLength>
</ipProtocolEndpoint>
<logicalDevice xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="networkPort">
<name>fe-0/3/3</name>
<portNumber>1</portNumber>
</logicalDevice>
</setIpAddressRequest> |
SetInterfaceDescription
This method sets the specified description in a single interface.
| Value | Description | |
|---|---|---|
| URL | http://hostname:8888/opennaas/router/{resourceName}/ip/setInterfaceDescription | |
| Method | POST | |
| Body Parameter | LogicalPort | LogicalPort contaning the name of the interface and the descrition to be set. |
| Return | - |
Body Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<logicalPort>
<name>fe-0/3/3</name>
<description>Interface connected to internet</description>
</logicalPort> |