UnUsed IP

 

Provides the details on unused IP in your network. This operation do not require any additional parameter. The following formats are supported:

XML Format

URL http://localhost:7080/oputilsapi/ipam?&key=9a5525a4-d7d4-48aa-96fe-caa5ac524346&v=1&format=XML&operation=GET_UNUSED_IP&subnetAddress=192.168.27.0
Parameters

subnetAddress =<ip-address>
Example: ipAddress=192.168.27.0

Operation

GET_UNUSED_IP

Success Response

<resource>

  <status>Success</status>

  <input>

  <operation>GET_ALL_UNUSED_IP</operation>

  </input>

  <output>

    <ips>

      <ip>

        <ip-address>192.168.27.1</ip-address>

        <dns-name>null</dns-name>

        <status>Available</status>

        <reserved-status>Not Reserved</reserved-status>

        <subnet-address>192.168.27.0</subnet-address>

        <mac-address>null</mac-address>

        <subnet-mask>255.255.255.0</subnet-mask>

        <last-alive-time>null</last-alive-time>

        <system-name>null</system-name>

        <system-description>null</system-description>

        <oid>null</oid>

        <location>null</location>

        <last-scan-time>2013-10-18 11:53:53.008</last-scan-time>

        <owner>null</owner>

      </ip>

      <ip>

        <ip-address>192.168.27.246</ip-address>

        <dns-name>null</dns-name>

        <status>Available</status>

        <reserved-status>Not Reserved</reserved-status>

        <subnet-address>192.168.27.0</subnet-address>

        <mac-address>null</mac-address>

        <subnet-mask>255.255.255.0</subnet-mask>

        <last-alive-time>null</last-alive-time>

        <system-name>null</system-name>

        <system-description>null</system-description>

        <oid>null</oid>

        <location>null</location>

        <last-scan-time>2013-10-18 14:25:16.313</last-scan-time>

        <owner>null</owner>

      </ip>

      <ip>

        <ip-address>192.168.27.248</ip-address>

        <dns-name>null</dns-name>

        <status>Available</status>

        <reserved-status>Not Reserved</reserved-status>

        <subnet-address>192.168.27.0</subnet-address>

        <mac-address>null</mac-address>

        <subnet-mask>255.255.255.0</subnet-mask>

        <last-alive-time>null</last-alive-time>

        <system-name>null</system-name>

        <system-description>null</system-description>

        <oid>null</oid>

        <location>null</location>

        <last-scan-time>2013-10-18 14:25:16.316</last-scan-time>

        <owner>null</owner>

      </ip>

      <ip>

        <ip-address>192.168.27.249</ip-address>

        <dns-name>null</dns-name>

        <status>Available</status>

        <reserved-status>Not Reserved</reserved-status>

        <subnet-address>192.168.27.0</subnet-address>

        <mac-address>null</mac-address>

        <subnet-mask>255.255.255.0</subnet-mask>

        <last-alive-time>null</last-alive-time>

        <system-name>null</system-name>

        <system-description>null</system-description>

        <oid>null</oid>

        <location>null</location>

        <last-scan-time>2013-10-18 14:25:16.317</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>

 

JSON Format

URL http://localhost:7080/oputilsapi/ipam?&key=9a5525a4-d7d4-48aa-96fe-caa5ac524346&v=1&format=JSON&operation=GET_UNUSED_IP&subnetAddress=192.168.27.0
Parameters

subnetAddress =<ip-address>
Example: ipAddress=192.168.110.0

Operation

GET_UNUSED_IP

Success Response

{

   "result":[

      {

         "ip-address":"192.168.27.192",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:54.219",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      },

      {

         "ip-address":"192.168.27.69",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:53.013",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      },

      {

         "ip-address":"192.168.27.41",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:53.01",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      },

      {

         "ip-address":"192.168.27.26",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:53.01",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      },

      {

         "ip-address":"192.168.27.133",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:54.218",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      },

      {

         "ip-address":"192.168.27.245",

         "status":"Available",

         "subnet-address":"192.168.27.0",

         "last-scan-time":"2013-10-18 11:53:54.708",

         "subnet-mask":"255.255.255.0",

         "reserved-status":"Not Reserved"

      }

   ],

   "input":"{subnetAddress=192.168.27.0}",

   "status":"Success"

}

Failure Response

{

   "message":"Invalid Subnet. Please add the subnet and Try again.",

   "input":"{subnetAddress=192.168.27.0}",

   "status":"Failure"

}

Copyright © 2004-2012, ZOHO Corp. All Rights Reserved.
ManageEngine