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
Property Description
n
tenantLabel:
Name of the tenant.
n
subtenantRef:
ID of the business group.
n
subtenantLabel:
Name of the business group.
n
providerBinding:
Contains the provider-side identifier of this item.
n
bindingId:
binding ID.
n
providerRef:
Provider.
n
forms:
Specifies the form associated with catalog items of this type.
n
callbacks:
Specifies the call-backs to the provider supported by this catalog item.
n
isNoteworthy:
Indicates that this catalog item should be highlighted to users for a period of time.
n
dateCreated:
Specifies the date this item was created in the catalog.
n
lastUpdatedDate:
Specifies the date this item was last updated in the catalog.
n
iconId:
Specifies the associated icon representing this item.
n
catalogItemTypeRef:
Specifies the type of the catalog item.
n
serviceRef:
Specifies the catalog service that contains this catalog item.
n
outputResourceTypeRef:
Specifies the type of the resource that results from requesting this catalog item.
Metadata Specifies the paging-related data:
n
Size:
Specifies the maximum number of rows per page.
n
totalElements:
Specifies the number of rows returned.
n
totalPages:
Specifies the total number of pages of data available.
n
Number:
Specifies the current page number.
Programming Guide
VMware, Inc. 78