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
Syntax for Requesting an Amazon Machine
You can use the vRealize Automation REST API catalog service to request an Amazon machine as
defined in your chosen blueprint, or you can override the default values of the blueprint by adding
properties to your JSON input file to override default values. For example, you can choose a specific
location.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$host/catalog-service/api/consumer/requests/requestId
$host Specifies the host name and fully qualified domain name or IP address of the
vRealize Automation identity server.
$token Specifies a valid HTTP bearer token with necessary credentials.
JSON file or string input Add required JSON input to the command line. See Syntax for Constructing a
JSON File for an Amazon Machine Request.
JSON Template for Command Input
Use the following JSON template sample to create a JSON command input string set or file for use in the
command line.
{
"@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": {
"type": "string",
"value": "business_group_ID"
}
},
Programming Guide
VMware, Inc. 82