Provides the details on the IP address that are reserved in your network. This operation do not require any additional parameter. The following formats are supported:
URL | http://localhost:7080/oputilsapi/ipam?&key=9a5525a4-d7d4-48aa-96fe-caa5ac524346&v=1&format=XML&operation=GET_RESERVED_IP&subnetAddress=192.168.26.0 |
Parameters | subnetAddress
=<ip-address> |
Operation | GET_RESERVED_IP |
Success Response | <resource> <status>Success</status> <input> <operation>GET_ALL_RESERVED_IP</operation> </input> <output> <ips> <ip> <ip-address>192.168.26.3</ip-address> <dns-name>null</dns-name> <status>Available</status> <reserved-status>Reserved - Static IP</reserved-status> <subnet-address>192.168.26.0</subnet-address> <mac-address>null</mac-address> <subnet-mask>255.255.255.0</subnet-mask> <subnet-size>254</subnet-size> <last-alive-time>null</last-alive-time> <last-scan-time>2013-10-18 14:25:15.222</last-scan-time> <owner>null</owner> </ip> <ip> <ip-address>192.168.26.6</ip-address> <dns-name>null</dns-name> <status>Available</status> <reserved-status>Reserved - Static IP</reserved-status> <subnet-address>192.168.26.0</subnet-address> <mac-address>null</mac-address> <subnet-mask>255.255.255.0</subnet-mask> <subnet-size>254</subnet-size> <last-alive-time>null</last-alive-time> <last-scan-time>2013-10-18 14:25:15.23</last-scan-time> <owner>null</owner> </ip> </ips> </output> </resource> |
Failure Response | <resource> <status>Failure</status> <message>Invalid Subnet. Please add the subnet and Try again.</message> </resource> |
URL | http://localhost:7080/oputilsapi/ipam?&key=9a5525a4-d7d4-48aa-96fe-caa5ac524346&v=1&format=JSON&operation=GET_RESERVED_IP&subnetAddress=192.168.26.0 |
Parameters | subnetAddress =<ip-address> Example: ipAddress=192.168.26.0 |
Operation | GET_RESERVED_IP |
Success Response | { "result":[ { "ip-address":"192.168.26.3", "subnet-size":254, "status":"Available", "subnet-address":"192.168.26.0", "last-scan-time":"2013-10-18 11:54:05.405", "subnet-mask":"255.255.255.0", "reserved-status":"Reserved - Static IP" }, { "ip-address":"192.168.26.6", "subnet-size":254, "status":"Available", "subnet-address":"192.168.26.0", "last-scan-time":"2013-10-18 11:54:05.405", "subnet-mask":"255.255.255.0", "reserved-status":"Reserved - Static IP" } ], "input":"{}", "status":"Success" } |
Failure Response | { "message":"Invalid Subnet. Please add the subnet and Try again.", "input":"{subnetAddress=192.168.26.0}", "status":"Failure" } |