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
"label" : "iaas-service"
}
},
"forms" : null,
"callbacks" : null,
"isNoteworthy" : false,
"dateCreated" : "2014-09-18T23:50:52.858Z",
"lastUpdatedDate" : "2014-11-11T23:52:14.407Z",
"iconId" : "cafe_default_icon_genericCatalogItem",
"catalogItemTypeRef" : {
"id" : "Infrastructure.vCloudAir",
"label" : "vCD vApp"
},
"serviceRef" : {
"id" : "ca6b9988-fe07-4b25-b465-3e0c905b7aad",
"label" : "vCloud Air machine"
},
"outputResourceTypeRef" : {
"id" : "Infrastructure.vCloudAir",
"label" : "vCloud Air machine"
}
} ],
"metadata" : {
"size" : 10,
"totalElements" : 3,
"totalPages" : 1,
"number" : 1,
"offset" : 0
}
Syntax for Constructing a JSON File for a vCloud Air Machine Request
You can use the vRealize Automation REST API catalog service to construct a JSON file for use in a
command line vCloud Air machine request.
Prerequisites
n
Obtain the information to add to the JSON file. See Syntax for Finding the Published Blueprint for a
vCloud Air Machine Request.
n
Use an XML editor to create a JSON file.
Example: JSON Input File
Use the following JSON input file sample when constructing a file.
{
"@type": "CatalogItemRequest",
"catalogItemRef": {
"id": "c2cacf7c-b3c8-47fb-a938-2c09910b6713"
},
"organization": {
"tenantRef": "abx",
"subtenantRef": "43a2f89a-c04e-4941-abc5-b4dc68a2810d"
},
Programming Guide
VMware, Inc. 63