Subnet Summary

 

Provides you the summary details of a specified subnet. You should specify the IP 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_SUMMARY&subnetAddress=192.168.110.0
Parameters subnetAddress = <ip-address>
Example: ipAddress = 192.168.110.0
Operation GET_SUBNET_SUMMARY
Success Response

<resource>

  <status>Success</status>

  <input>

  <operation>GET_SUBNET_SUMMARY</operation>

  <subnetAddress>192.168.44.0</subnetAddress>

  </input>

  <output>

    <subnets>

      <subnet>

        <subnet-address>192.168.44.0</subnet-address>

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

        <subnet-name/>

        <subnet-description/>

        <broadcast-address>192.168.44.255</broadcast-address>

        <subnet-size>254</subnet-size>

        <scan-status>Scanned</scan-status>

        <available>0</available>

        <used>0</used>

        <transient>254</transient>

        <not-scanned>0</not-scanned>

        <used-percentage>0</used-percentage>

        <reserved-count>0</reserved-count>

        <reserved-available>0</reserved-available>

        <reserved-used>0</reserved-used>

        <reserved-transient>0</reserved-transient>

        <reserved-not-scanned>0</reserved-not-scanned>

        <ip-in-active-directory>0</ip-in-active-directory>

        <reverse-lookup-failed-count>0</reverse-lookup-failed-count>

        <forward-lookup-failed-count>0</forward-lookup-failed-count>

        <ip-mismatch-count>0</ip-mismatch-count>

        <created-by>--</created-by>

        <added-time>18 Oct 13, 12:11 PM</added-time>

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

        <vlan-name/>

        <location/>

        <test/>

        <custsttt/>

      </subnet>

    </subnets>

  </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_SUBNET_SUMMARY&subnetAddress=192.168.110.0
Parameters

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

Operation

GET_SUBNET_SUMMARY

Success Response

{

   "result":{

      "added-time":"03 Oct 13, 04:13 PM",

      "test":"",

      "location":"First Floor",

      "custsttt":"",

      "used":"2",

      "vlan-name":"VLAN_2",

      "broadcast-address":"192.168.110.255",

      "ip-mismatch-count":"0",

      "forward-lookup-failed-count":"0",

      "used-percentage":"00.79",

      "reserved-available":"0",

      "reverse-lookup-failed-count":"2",

      "scan-status":"Scanned",

      "reserved-not-scanned":"0",

      "reserved-count":"0",

      "transient":"252",

      "not-scanned":"0",

      "created-by":"admin",

      "available":"0",

      "last-scan-time":"03 Oct 13, 04:31 PM",

      "subnet-size":"254",

      "subnet-name":"",

      "reserved-used":"0",

      "subnet-address":"192.168.110.0",

      "subnet-description":"This Subnet for testing Team",

      "ip-in-active-directory":"0",

      "reserved-transient":"0",

      "subnet-mask":"255.255.255.0"

   },

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

   "status":"Success"

}

Failure Response

{

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

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

   "status":"Failure"

}

 

 

 

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