You can use the vRealize Automation REST API to create a external network profile using external IPAM.


Use the supported input parameters to control the command output.








Specifies the host name and fully qualified domain name or IP address of the vRealize Automation identity server.


Specifies a valid HTTP bearer token with necessary credentials.


The HTTP body specifies the information for creating an external IPAM profile.

  • profileType

    Specify EXTERNAL for this parameter.

  • id

    Specifies null.

  • name

    Specifies the name of the profile.

  • IPAMEndpointId

    Specifies the endpoint ID for an external IPAM provider.

  • addressSpaceExternalId

    Specify the address space of the IPAM provider. This is represented in the vRealize Automation UI as Address Space.

  • description

    Optionally, can specify a description for the profile. If you do not provide a description, code "null" for this parameter.

  • definedRanges

    Specifies parameters that set up defined address ranges:

    • externalId

      Specify the address range of the IPAM provider.

      This is the tie between vRealize Automation and he external IPAM provider. When you edit a network profile, vRealize Automation pulls information about the address ranges based on the external ID.

    • name

      Optionally, you can specify a descriptive name for the range.

    • description

    • state

      Specify "UNALLOCATED" for this value.

    • beginIPv4Address

      Specify "null" for this parameter.

    • endIPv4Address

      Specify "null" for this parameter.


The command output contains property names and values based on the command input parameters.




The http response should contain a Location attribute that is formatted as https://$host/iaas-proxy-provider/api/keyPairs/$keypairID.


The HTTP response should contain a Location attribute that is formatted as https://$host/iaas-proxy-provider/api/network/profiles/$networkProfileID.


Specifies the unique identifier of the new network profile.

curl Command

The following example command creates an external IPAM profile.

curl --insecure -H "Accept:application/json" 
-H "Authorization: Bearer $token" 
https://$host/iaas-proxy-provider/api/$networkProfileID -d “

    "profileType" : "EXTERNAL",
	"id" : null,
	"@type" : "ExternalNetworkProfile",
	"name" : "External IPAM",
	"IPAMEndpointId" : "c20f305c-07a5-4ba7-88ac-35da7b9713e0",
	"addressSpaceExternalId" : "address-space-4",
	"description" : null,
	"definedRanges" : [{
			"externalId" : "network-1",
			"name" : "",
			"description" : "Created by vRO package stub workflow",
			"state" : "UNALLOCATED",
			"beginIPv4Address" : null,
			"endIPv4Address" : null

JSON Output

The output contains an empty HTTP response body and the location and network profile ID in the header statement.


Copy the location URL into a text editor for future use.