7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
5
Approving a Machine Request 63
Approve a Machine Request 63
Work Item Service Examples for Approving a Machine Request 64
Syntax for Listing Work Items 65
Syntax for Getting Work Item Details 71
Syntax for Constructing a JSON File to Approve a Machine Request 76
Syntax for Approving a Submitted Machine Request 79
Syntax for Updating Price Information 81
6
Listing Provisioned Resources 85
Prerequisites for Listing Provisioned Resources 85
Display Your Provisioned Resources Example 85
Display Provisioned Resources by Resource Type Example 89
Display All Available Resource Types Example 92
Display Provisioned Resources by Business Groups You Manage Example 94
View Machine Details Example 103
7
Managing Provisioned Deployments 107
Manage Provisioned Deployments 107
Power Off 108
Change Lease 109
Catalog Service Examples for Managing Provisioned Deployments 111
Syntax for Getting Deployment Details 111
Syntax for Navigating to the Children of a Deployed Resource 115
8
Working with Reservations 122
Prerequisites for Working With Reservations 123
Create a Reservation 123
Display a List of Supported Reservation Types 124
Displaying a Schema Definition for a Reservation 127
Get the Business Group ID for a Reservation 153
Get a Compute Resource for the Reservation 155
Getting a Resources Schema by Reservation Type 158
Creating a Reservation By Type 162
Verify a Reservation and Get Reservation Details 173
Display a List of Reservations 181
Update a Reservation 186
Delete a Reservation 191
Service Examples for Working with Reservations 191
Syntax for Displaying a List of Reservations 193
Syntax for Displaying a Schema Definition for a vSphere Reservation 199
Programming Guide
VMware, Inc. 4