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
Example: JSON Output
The highlighted resource action ID corresponds to the reprovisioning actions that are available for the
specified machine.
{
"links" : [ ],
"content" : [ {
"@type" : "ConsumerResourceOperation",
"name" : "Reprovision",
"description" : "Reprovision a machine.",
"iconId" : "machineReprovision.png",
"type" : "ACTION",
"id" : "a1caee9b-d67f-41e8-a7b3-131616a0f6ac",
"extensionId" : null,
"providerTypeId" : "com.mycompany.csp.iaas.blueprint.service",
"bindingId" : "Infrastructure.Machine.Action.Reprovision",
"hasForm" : false,
"formScale" : null
} ]
}
Syntax for Reprovisioning a Provisioned Machine
You can use the REST API catalog service to reprovision a provisioned machine, or perform other entitled
and enabled actions .
Input
Use the supported input parameters to control the command output.
The JSON Template Values table describes the information used in, in conjunction with the JSON
template format, to create a JSON text file to include in the reprovision command request.
Table 3‑5. JSON Template Values
Property Description
resourceRef : id Specifies the resource ID of the resource on which the operation is to be performed.
resourceActionRef : id Specifies the resource action ID on which the operations is to be performed.
organization Specifies the organization to which the resource belongs. Supply the tenant and
subtenant information as necessary. The tenant corresponds to the organization and the
subtenant corresponds to the business group.
State Specifies the state of the request. At the time of requesting, the state is SUBMITTED.
The other possible state values are UNSUBMITTED, SUBMITTED, DELETED,
PENDING_PRE_APPROVAL, PRE_APPROVAL_SEND_ERROR, PRE_APPROVED,
PRE_REJECTED, IN_PROGRESS, PROVIDER_SEND_ERROR,
PROVIDER_COMPLETED, PROVIDER_FAILED, PENDING_POST_APPROVAL,
POST_APPROVAL_SEND_ERROR, POST_APPROVED,
POST_REJECTION_RECEIVED, ROLLBACK_ERROR, POST_REJECTED,
SUCCESSFUL, and FAILED.
Programming Guide
VMware, Inc. 129