Get IPv4 Range by IP Address - BlueCat Address Manager - 8.2.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
8.2.0

Returns the DHCP Range containing the specified IPv4 address. Use this method to find the Configuration, IPv4 Block, IPv4 Network, or DHCP Range containing a specified address. You can specify the type of object to be returned, or you can leave the type of object empty to find the most direct container for the object.

Output / Response

Returns an APIEntity for the object containing the specified address. If no object is found, returns an empty APIEntity. If ObjectTypes.IP4Block, ObjectTypes.IP4Network, or ObjectTypes.DHCP4Range is specified as the type parameter, returns an object of the specified type. If an empty string ("") is specified as the type parameter, returns the most direct container for the IPv4 address.

API call:

APIEntity getIPRangedByIP ( long containerId, String type, String address )
Parameter Description
containerId The object ID of the container in which the IPv4 address is located. This can be a Configuration, IPv4 Block, IPv4 Network, or DHCP Range. When you do not know the block, network, or range in which the address is located, specify the configuration.
type The type of object containing the IPv4 address. Specify ObjectTypes.IP4Block, ObjectTypes.IP4Network, or ObjectTypes.DHCP4Range to find the block, network, or range containing the IPv4 address. Specify an empty string ("") to return the most direct container for the IPv4 address.
address An IPv4 address.