IPv4 blocks

Return an array of entity IDs linked using the given link type to the given source or destination entity ID.

API method: GET /v1/getLinkedEntitiesEx

Examples

Input:

{
    "linkType": "UniqueLinkTypeName",
    "sourceEntityId": 81253
}

Output:

[23125]

OR

Input:

{
    "linkType": "UniqueLinkTypeName",			
    "destinationEntityId": 23125
}

Output:

[81253]

Parameters

linkType—enter a unique name for the user-defined link.
sourceEntityId—enter the source entity ID.
destinationEntityId— enter the destination entity ID.

Note:

You must provide either sourceEntityId or destinationEntityId but not both.
You cannot retrieve a name that is a reserved link type name. For a list of reserved link type names, refer to Reference: Reserved link type names.

Return an array of objects detailing entities currently linked by a given UDL type, with an optional parameter to qualify results by source or destination entity ID.

API method: GET /v1/getLinkedEntitiesByUDL

Example

Input:

{
    "linkType": "UniqueLinkTypeName",
    "entityId": 100895
}

Output:

[
    {
        "sourceId": 100895,
        "description": "Description for the link",
        "destinationId": 100897
    },
    {
        "sourceId": 100895,
        "description": "Description for the link",
        "destinationId": 100904
    }
]

Parameters

linkType—enter a unique name for the user-defined link.
entityId—(optional) enter the source or destination entity ID. If an ID is not provided, all linked entities matching the specified link type will be returned.

Note:

If providing an entityId parameter, you must provide either the source entity ID, or the destination entity ID, but not both.
You cannot retrieve a name that is a reserved link type name. For a list of reserved link type names, refer to Reference: Reserved link type names.

The following table displays the object type and the corresponding value (TypeName) for the sourceEntityTypes and destinationEntityTypes parameters.

Note: For entities that have two corresponding TypeNames, you must enter the two TypeNames as the values.

Entity	TypeName
View	View
Zone	Zone
IP4Block	IP4Block, IP4Ranged
IP4Network	IP4Network, IP4Ranged
IP4Address	IP4Addr
IP4IPGroup	IP4IPGroup
IP6Block	IP6Block, IP6Ranged
IP6Network	IP6Network, IP6Ranged
IP6Address	IP6Addr
DHCP4Range	IP4DHCPRange
DHCP6Range	IP6DHCPRange
MACPool	UserMACPool
DenyMACPool	DenyMACPool
MACAddress	MACAddr
Server	Server
ServerGroup	ServerGroup
Device	Device

The following table lists all reserved link type names that cannot be used as a value for the linkType parameter.

Reserved link type names
AUTH_AUTH
BN
DEPLOY_TO_SERVERS
DEV_IP4
DEV_IP6
DEV_SUBTYPE
DEV_TYPE
DF_D
DF_V
DHCP_SERVICE_PRINCIPAL
DNS64_ACL
DNS_SERVICE_PRINCIPAL
DUID_IP6
FAV
GRP_MEMBER
HSM_CONFIGURATION
HSM_SERVER
IP
IP4_UID
IP4NT
IP4NT_TEMPLATE_ITEM
IP6
IP6NT
KDC
KRBREALM_DHCPZONE
LINK_IP_OVERLAP
LINK_NP_NPV
LINK_NP_NR
LOC
MACA_IP
MACP_MACA
POOL_MEMBER
SCHD_DEPLOYMENT
SCHD_REPORT
SERVER_GROUP
SIGNINGPOLICY_ENTITY
SN
TAG
TEMPLATE_ITEM
TEMPLATE_ZONE
USER_GROUP
USER_REPORT
WIINS_SRV_VIEW
XHA_PASSIVE
XHA_SHADOW
ZTS

The IP core contains information about network structures or allocation blocks and static and dynamic allocations.

This information is integrated with the DNS core to keep the DNS space current with the IP networks that it represents. DHCP configuration is modeled on the allocation blocks in the Address Manager IP core and is kept current by real-time feedback from managed servers. Dynamic DNS changes, such as address allocations, from Active Directory and other updating systems are sent to Address Manager in real time, showing administrators that an automated process made a configuration change.

An IPv4 block is a group of IPv4 addresses that is separated from a larger network by subnetting.

You cannot route addresses within a block until you have allotted them into a network. You can add and return blocks by IP range or CIDR notation. You can specify default DNS domains for IPv4 blocks with the defaultDomains property. To add a single default domain, specify the object ID for the required domain. To add multiple default domains, specify the object IDs for multiple domains as a comma-delimited list of domain object IDs.

Add a new IPv4 block using CIDR notation.

API method: POST /v1/addIP4BlockByCIDR

Add a new IPv4 block defined by an address range.

API method: POST /v1/addIP4BlockByRange

Create an IPv4 or IPv6 block from a list of IPv4 or IPv6 blocks or networks. All blocks and networks must have the same parent but it does not need to be contiguous.

API method: POST /v1/addParentBlock

Create an IPv4 or IPv6 block with a name from a list of IPv4 or IPv6 blocks or networks. All blocks and networks must have the same parent but it does not need to be contiguous.

API method: POST /v1/addParentBlockWithProperties

Return the IPv4 block containing the specified IPv4 address.

API method: GET /v1/getIPRangedByIP

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 you specify ObjectTypes.IP4Block, ObjectTypes.IP4Network, or ObjectTypes.DHCP4Range as the type parameter, returns an object of the specified type. If you specify an empty string ("") as the type parameter, returns the most direct container for the IPv4 address.

Return an IPv4 block by calling the block using CIDR notation.

API method: GET /v1/getEntityByCIDR

Return an IPv4 block by calling the block using its address range.

API method: GET /v1/getEntityByRange

Merge specified IPv4 blocks into a single block. The blocks must all have the same parent and must be contiguous. Blocks whose parent object is the configuration cannot contain networks.

API method: POST /v1/mergeBlocksWithParent

Merge specified IPv4 blocks or IPv4 networks into a single IPv4 block or IPv4 network. The list of objects to be merged must all be of the same type (for example, all blocks or all networks). The objects must all have the same parent and must be contiguous.

API method: POST /v1/mergeSelectedBlocksOrNetworks

Update and delete IPv4 blocks using generic methods.

API method

Update the IPv4 block name: PUT /v1/update

Delete the IPv4 block: DELETE /v1/delete

Get linked entities for user-defined link

Get linked entities by user-defined link

Reference: User-defined links entity mappings

Reference: Reserved link type names

IPAM

Add IPv4 block by CIDR

Add IPv4 block by range

Add parent block

Add parent block with properties

Get IPv4 range by IP address

Get IPv4 block by CIDR

Get IPv4 block by range

Merge blocks with parent

Merge selected blocks or networks

IPv4 block generic methods