7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for Working With Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
Input Description
$token Specifies a valid HTTP bearer token with necessary credentials.
HTTP Body The HTTP body specifies the information for creating an external
IPAM profile.
n
profileType: Specify EXTERNAL for this parameter.
n
id: Specifies null.
n
name: Specifies the name of the profile.
n
IPAMEndpointId: Specifies the endpoint ID for an external
IPAM provider.
n
addressSpaceExternalId: Specify the address space of the
IPAM provider. This is represented in the
vRealize Automation UI as Address Space.
n
description: Optionally, can specify a description for the
profile. If you do not provide a description, code "null" for
this parameter.
n
definedRanges: Specifies parameters that set up defined
address ranges:
n
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.
n
name: Optionally, you can specify a descriptive name for
the range.
n
description
n
state: Specify "UNALLOCATED" for this value.
n
beginIPv4Address: Specify "null" for this parameter.
n
endIPv4Address: Specify "null" for this parameter.
Output
The command output contains property names and values based on the command input parameters.
Property Description
status If the command is successful, the HTTP status is 201 Created.
Header.Location The HTTP response should contain a Location attribute that is formatted as
https://$vRA/iaas-proxy-
provider/api/network/profiles/$networkProfileID.
$networkProfileID Specifies the unique identifier of the new network profile.
Programming Guide
VMware, Inc. 316