vRealize Automation IPAM Service API

IPAM Service API Specification

What Is the IPAM Service?

The IP address management (IPAM) service provides tenanted IPAM operations (static IP management) through registered IPAM providers. It allows retrieval of available IP address ranges for a single IPAM provider. Once the address ranges have been imported into vRA, administrators can assign them to network profiles that are used for provisioning of VMs and machines.

Provisioned VMs and machines then obtain their IP addresses, DNS configuration, and gateway information from the IPAM solution provider.

Typical Use Cases

A system administrator, IaaS administrator, or fabric administrator creates a network profile. During profile configuration, the administrator imports IP address ranges into vRA from a registered IPAM service provider.

Key Concepts

IPAM Solution Provider

A service provider for which an IPAM endpoint is configured.

External Network Profile

Network profile information identifies the external network properties and specifies settings for an existing network. An external network profile is a requirement of NAT and routed network profiles.

IP Address Range

A range of static IP addresses for use in provisioning a network. An external network profile must have at least one static IP range for use with routed and NAT network profiles.

How the IPAM Service Works

A user or application developer specifies an IPAM endpoint that enables communication with a IPAM solution provider application.

After the endpoint is defined, the external IPAM service is accessible from the vRA user interface and administrators can choose IP address ranges from the external IPAM provider.

The APIs provided by the service allow users to:

  • Retrieve the list of available IP ranges for a single IPAM provider
  • Allocate a subrange of IPs
  • Deallocate a subrange of IPs

Additional Information

For more detailed information on using the the API, refer to the vRA Programming Guide.


Related Documentation

Related SDKs

Related Sample Code