Subnet Details

 

Provides the complete details of all the IP Addresses in the specified subnet. You would need to specify the Subnet address as a parameter for this operation. 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_SUBNET_DETAIL&subnetAddress=192.168.110.0
Parameters subnetAddress = <ip-address>
Example: ipAddress = 192.168.110.1
Operation GET_SUBNET_DETAIL
Success Response

<resource>

  <status>Success</status>

  <input>

  <operation>GET_SUBNET_DETAIL</operation>

  <subnetAddress>192.168.110.0</subnetAddress>

  </input>

  <output>

    <ips>

      <ip>

        <ip-address>192.168.110.1</ip-address>

        <mac-address/>

        <ip-to-dns/>

        <dns-status>N/A</dns-status>

        <status>Transient</status>

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

        <alias-name/>

        <phone-number/>

        <last-alive-time/>

        <last-modified-time/>

        <last-scan-time>18 Oct 13, 02:03 PM</last-scan-time>

        <asset-tag/>

        <dns-to-ip/>

        <device-type/>

        <authenticity/>

        <active-directory-name/>

        <system-name/>

        <system-description/>

        <location/>

        <owner/>

        <nic-type/>

        <connected-switch/>

        <connected-switch-port/>

        <connected-port-ifalias/>

        <connected-port-ifname/>

        <connected-port-ifindex/>

        <connected-port-speed/>

        <connected-port-iftype/>

        <connected-port-ifmtu/>

        <connected-port-duplex/>

        <cd-key/>

        <serial-number/>

        <mygod/>

        <custColn/>

      </ip>

      <ip>

        <ip-address>192.168.110.2</ip-address>

        <mac-address/>

        <ip-to-dns/>

        <dns-status>N/A</dns-status>

        <status>Transient</status>

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

        <alias-name/>

        <phone-number/>

        <last-alive-time/>

        <last-modified-time/>

        <last-scan-time>18 Oct 13, 02:03 PM</last-scan-time>

        <asset-tag/>

        <dns-to-ip/>

        <device-type/>

        <authenticity/>

        <active-directory-name/>

        <system-name/>

        <system-description/>

        <location/>

        <owner/>

        <nic-type/>

        <connected-switch/>

        <connected-switch-port/>

        <connected-port-ifalias/>

        <connected-port-ifname/>

        <connected-port-ifindex/>

        <connected-port-speed/>

        <connected-port-iftype/>

        <connected-port-ifmtu/>

        <connected-port-duplex/>

        <cd-key/>

        <serial-number/>

        <mygod/>

        <custColn/>

      </ip>

      .........

      <ip>

        <ip-address>192.168.110.253</ip-address>

        <mac-address/>

        <ip-to-dns/>

        <dns-status>N/A</dns-status>

        <status>Transient</status>

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

        <alias-name/>

        <phone-number/>

        <last-alive-time/>

        <last-modified-time/>

        <last-scan-time>18 Oct 13, 02:03 PM</last-scan-time>

        <asset-tag/>

        <dns-to-ip/>

        <device-type/>

        <authenticity/>

        <active-directory-name/>

        <system-name/>

        <system-description/>

        <location/>

        <owner/>

        <nic-type/>

        <connected-switch/>

        <connected-switch-port/>

        <connected-port-ifalias/>

        <connected-port-ifname/>

        <connected-port-ifindex/>

        <connected-port-speed/>

        <connected-port-iftype/>

        <connected-port-ifmtu/>

        <connected-port-duplex/>

        <cd-key/>

        <serial-number/>

        <mygod/>

        <custColn/>

      </ip>

    </ips>

  </output>

</resource>

Failure Response

<resource>

  <status>Failure</status>

  <message>Invalid Subnet. Please add the subnet and Try again.</message>

</resource>

 

 

<resource>

  <status>Failure</status>

  <message>Subnet Scan is in progress. Please wait for some time 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_SUBNET_DETAIL&subnetAddress=192.168.110.0
Parameters

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

Operation

GET_SUBNET_DETAIL

Success Response

{

   "result":[

      {

         "active-directory-name":"",

         "location":"",

         "connected-port-duplex":"",

         "phone-number":"",

         "last-alive-time":"18 Oct 13, 11:09 AM",

         "mygod":"",

         "authenticity":"",

         "serial-number":"",

         "reserved-status":"Not Reserved",

         "ip-address":"192.168.110.1",

         "connected-port-ifname":"",

         "dns-to-ip":"",

         "custColn":"",

         "cd-key":"",

         "alias-name":"",

         "status":"Used",

         "system-name":"",

         "connected-port-iftype":"",

         "dns-status":"Reverse Lookup Failed",

         "connected-switch":"",

         "last-scan-time":"18 Oct 13, 11:09 AM",

         "mac-address":"",

         "connected-switch-port":"",

         "nic-type":"",

         "connected-port-speed":"",

         "device-type":"",

         "connected-port-ifalias":"",

         "connected-port-ifindex":"",

         "ip-to-dns":"",

         "system-description":"",

         "owner":"",

         "connected-port-ifmtu":"",

         "last-modified-time":"",

         "asset-tag":""

      },

      {

         "active-directory-name":"",

         "location":"",

         "connected-port-duplex":"",

         "phone-number":"",

         "last-alive-time":"18 Oct 13, 11:09 AM",

         "mygod":"",

         "authenticity":"",

         "serial-number":"",

         "reserved-status":"Not Reserved",

         "ip-address":"192.168.110.2",

         "connected-port-ifname":"",

         "dns-to-ip":"",

         "custColn":"",

         "cd-key":"",

         "alias-name":"",

         "status":"Used",

         "system-name":"",

         "connected-port-iftype":"",

         "dns-status":"Reverse Lookup Failed",

         "connected-switch":"",

         "last-scan-time":"18 Oct 13, 11:09 AM",

         "mac-address":"",

         "connected-switch-port":"",

         "nic-type":"",

         "connected-port-speed":"",

         "device-type":"",

         "connected-port-ifalias":"",

         "connected-port-ifindex":"",

         "ip-to-dns":"",

         "system-description":"",

         "owner":"",

         "connected-port-ifmtu":"",

         "last-modified-time":"",

         "asset-tag":""

      },

      ..........,

      {

         "active-directory-name":"",

         "location":"",

         "connected-port-duplex":"",

         "phone-number":"",

         "last-alive-time":"",

         "mygod":"",

         "authenticity":"",

         "serial-number":"",

         "reserved-status":"Not Reserved",

         "ip-address":"192.168.110.253",

         "connected-port-ifname":"",

         "dns-to-ip":"",

         "custColn":"",

         "cd-key":"",

         "alias-name":"",

         "status":"Transient",

         "system-name":"",

         "connected-port-iftype":"",

         "dns-status":"N/A",

         "connected-switch":"",

         "last-scan-time":"18 Oct 13, 11:09 AM",

         "mac-address":"",

         "connected-switch-port":"",

         "nic-type":"",

         "connected-port-speed":"",

         "device-type":"",

         "connected-port-ifalias":"",

         "connected-port-ifindex":"",

         "ip-to-dns":"",

         "system-description":"",

         "owner":"",

         "connected-port-ifmtu":"",

         "last-modified-time":"",

         "asset-tag":""

      },

      {

         "active-directory-name":"",

         "location":"",

         "connected-port-duplex":"",

         "phone-number":"",

         "last-alive-time":"",

         "mygod":"",

         "authenticity":"",

         "serial-number":"",

         "reserved-status":"Not Reserved",

         "ip-address":"192.168.110.254",

         "connected-port-ifname":"",

         "dns-to-ip":"",

         "custColn":"",

         "cd-key":"",

         "alias-name":"",

         "status":"Transient",

         "system-name":"",

         "connected-port-iftype":"",

         "dns-status":"N/A",

         "connected-switch":"",

         "last-scan-time":"18 Oct 13, 11:09 AM",

         "mac-address":"",

         "connected-switch-port":"",

         "nic-type":"",

         "connected-port-speed":"",

         "device-type":"",

         "connected-port-ifalias":"",

         "connected-port-ifindex":"",

         "ip-to-dns":"",

         "system-description":"",

         "owner":"",

         "connected-port-ifmtu":"",

         "last-modified-time":"",

         "asset-tag":""

      }

   ],

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

   "status":"Success"

}

Failure Response

{

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

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

   "status":"Failure"

}

 

 

 

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