Page History

...

The SetIP method inserts the given IP in the specific interface, replacing the existing ones (if any) in the same family (either ipv4 or ipv6). It means, old IP addresses of the IP interface will be removed and it will contain only the new one. It accepts both ipv4 and ipv6 addresses.

Body Example

...

...

Body Example

Following example would set 192.168.50.10/24 address to interface specified in the query parameter.111/24 address to interface fe-0/3/3.1

<?xml version="1.0" encoding="UTF-8"?>
<setIpAddressRequest>
   <ipProtocolEndpoint>
      <IPv4Address>192.168.1.111</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>

SetIPv4

The SetIPv4 method inserts the given IP in the specific interface, replacing the existing ones (if any). It means, old addresses of the IP will be removed and it will contain only the new one. It accepts only IPv4 addresses.

Body Example

Following example would set 192.168.1.111/24 address to interface fe-0/3/3.1

<?xml version="1.0" encoding="UTF-8"?>
<setIpAddressRequest>
   <ipProtocolEndpoint>
      <IPv4Address>192.168.1.111</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>

SetIPv6

The SetIPv4 method inserts the given IP in the specific interface, replacing the existing ones (if any). It means, old addresses of the IP will be removed and it will contain only the new one. It accepts only IPv4 addresses.

Body Example

Following example would set 2067:f0d0:1002:51::4/32 address to interface fe-0/3/3.1

<?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>

AddIP

The AddIP method aggregates a new IP to the list of existing addresses of the specific interface. It accepts both ipv4 and ipv6 addresses.

Body Example

Following example would add 192.168.1.112/24 address to interface fe-0/3/3.1

<?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>

AddIPv4

The AddIPv4 method aggregates a new IP to the list of existing addresses of the specific interface. It accepts ipv4 addresses only.

Body Example

Following example would add 192.168.1.112/24 address to interface fe-0/3/3.1

<?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>

AddIPv6

192.168.50.10/24  

SetIPv4 and SetIPv6

These methods have the same logic than SetIP but for a specific IP version. Their usage is exactly the same that SetIP but they have different URLs

SetIPv4 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv4?interface={interfaceName}

SetIPv6 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv6?interface={interfaceName}

AddIP

The AddIP The AddIPv6 method aggregates a new IP to the list of existing addresses of the specific interface. It accepts ipv6 addresses onlyboth ipv4 and ipv6 addresses.

This method has same syntax than SetIP but differs in the HTTP method, which has to be set to PUT.

Body Example

Following example would add 2067:f0d0:1002:51::4/32 address to interface fe-0/3/3.1192.168.50.10/24 address to interface specified in the query parameter.

192.168.50.10/24  

AddIPv4 and AddIPv6

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 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv4?interface={interfaceName}

SetIPv6 URL: http://hostname:8888/opennaas/router/{resourceName}/ip/interfaces/addresses/ipv6?interface={interfaceName}

RemoveIP

The RemoveIP method deletes an existing IP of the list of addresses of the specific interface. It accepts both ipv4 and ipv6 addresses.

Body Example

Following example would remove 192.168.1.112/24 address from interface fe-0/3/3.1

...

Body Example

Following example would remove 192.168.1.112/24 address from interface fe-0/3/3.1

...

Body Example

Following example would remove 2607:f0d0:1002:51::4/32 address from interface fe-0/3/3.1

...

Body Example

<?xml version="1.0" encoding="UTF-8"?>
<logicalPort>
   <name>fe-0/3/3</name>
   <description>Interface connected to internet</description>
</logicalPort>