...
These methods have the same logic than AddIP but for a specific IP version. Their usage is exactly the same that AddIP but they have different URLs
SetIPv4 AddIPv4 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv4?interface={interfaceName}
SetIPv6 AddIPv6 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv6?interface={interfaceName}
...
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/removeIPinterfaces/addresses/ip?interface={interfaceName}&ip={ipAddress} | |
| Method | POSTDELETE | |
| Body Parameter | - | |
| Query 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<setIpAddressRequest>
<ipProtocolEndpoint>
<IPv4Address>192.168.1.112</IPv4Address>
<subnetMask>255.255.255.0</subnetMask>
</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> |
RemoveIPv4
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
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<setIpAddressRequest>
<ipProtocolEndpoint>
<IPv4Address>192.168.1.112</IPv4Address>
<subnetMask>255.255.255.0</subnetMask>
</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> |
RemoveIPv6
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.
...
| interface={interfaceName} | The name of the interface this operation applies to | |
| Query Parameter | ip={ipAddress} | IP address to delete with netmask prefix. (ipv4 and ipv6 supported). e.g. 192.168.50.10/24 |
| Return | - |
RemoveIPv4 and RemoveIPv6
These methods have the same logic than RemoveIP but for a specific IP version. Their usage is exactly the same that RemoveIP but they have different URLs
...
RemoveIPv4 URL:
http://hostname:8888/opennaas/router/{resourceName}/ip
...
POST
...
Body Example
...
| theme | Eclipse |
|---|---|
| language | html/xml |
...
/interfaces/addresses/ipv4?interface={interfaceName}
RemoveIPv6 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv6?interface={interfaceName}