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
Syntax for Displaying a Schema Definition for an Amazon Reservation 206
Syntax for Displaying a Schema Definition for a vCloud Air Reservation 221
Syntax for Getting the Business Group ID for a Reservation 233
Syntax for Getting a Compute Resource for a Reservation 236
Syntax for Getting Resources Schema for a vSphere Reservation 240
Syntax for Getting Resources Schema for an Amazon Reservation 242
Syntax for Getting Resources Schema for a vCloud Air Reservation 245
Syntax for Creating a vSphere Reservation 249
Syntax for Creating an Amazon Reservation 254
Syntax for Creating a vCloud Air Reservation 257
Syntax for Verifying a Reservation and Getting Reservation Details 262
Syntax for Displaying a List of Supported Reservation Types 270
Syntax for Updating a Reservation 275
Syntax for Deleting a Reservation 280
9
Working with Reservation Policies 282
Prerequisites for Working with Reservation Policies 282
List Reservation Policies Example 282
Create a Reservation Policy Example 284
Display a Reservation Policy by ID Example 286
Update a Reservation Policy Example 287
Deleting a Reservation Policy Example 288
10
Working with Key Pairs 290
Prerequisites for Working with Key Pairs 290
Get a Key Pair List Example 290
Create a Key Pair Example 293
Query a Key Pair Example 296
Update a Key Pair Example 298
Delete a Key Pair Example 299
11
Working with Network Profiles 301
Prerequisites for Working With Network Profiles 303
Get a Network Profile List Example 303
Create an External Network Profile Without IPAM Example 312
Create an External Network Profile Using External IPAM Example 314
Query a Network Profile Example 317
Update a Network Profile Example 321
Delete a Network Profile Example 322
12
Getting a List of Available IP Ranges 324
Get a List of Available IP Ranges for an IPAM Provider 324
Programming Guide
VMware, Inc. 5