7.1
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create 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
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- 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
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- 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 paramter.
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
Must specify the value that is chosen in the
vRealize Automation UI for 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
n
name
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 The http response should contain a Location attribute that is formatted as
https://$host/iaas-proxy-provider/api/keyPairs/$keypairID.
Header.Location The HTTP response should contain a Location attribute that is formatted as
https://$host/iaas-proxy-
provider/api/network/profiles/$networkProfileID.
$networkProfileID Specifies the unique identifier of the new network profile.
Programming Guide
VMware, Inc. 331