6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- 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
- Requesting a Machine By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Value Description
catalog_item_ID Specifies the value of CatalogItem ID in the machine blueprint
catalog item.
tenant_name Specifies the value of tenantRef in the machine blueprint catalog
item.
business_group_ID Specifies the value of subtenantRef in the machine blueprint
catalog item.
username@fqdn Specifies the user name of the consumer and business group
manager account and fully qualified domain name.
blueprint_ID Specifies the value of bindingId in the machine blueprint catalog
item.
notes Specifies notes that help to describe the request.
description Contains a description of the request.
reasons Contains a general reason for the request.
provider_reason Contains a general provider reason for the request.
Amazon_ins_type Specifies an Amazon instance type.
Request only Amazon instance types that are supported by the
blueprint. If necessary, consult the fabric administrator for details
on what blueprint supports. For information about Amazon
instance types, see Amazon product documentation.
Example: JSON Input File
The following example requests a small Amazon instance type, which overrides the default location to us-
west-1a. It also creates an EBS storage volume named Backup and mounts it to /dev/sdf.
{
"@type": "CatalogItemRequest",
"catalogItemRef": {
"id": "catalog_item_ID"
},
"organization": {
"tenantRef": "tenant_name",
"subtenantRef": "business_group_ID"
},
"requestedFor": "username@fqdn",
"state": "SUBMITTED",
"requestData": {
"entries": [{
"key": "provider-blueprintId",
"value": {
"type": "string",
"value": "blueprint_ID"
}
},
{
"key": "provider-provisioningGroupId",
"value": {
Programming Guide
VMware, Inc. 84