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
Reprovision a Machine Resource 127
Syntax for Viewing Available Actions for a Provisioned Machine 127
Syntax for Reprovisioning a Provisioned Machine 129
Working with Reservations 130
Create a Reservation 131
Display a List of Reservations 281
Update a Reservation 292
Delete a Reservation 302
Working with Reservation Policies 303
List Reservation Policies 303
Create a Reservation Policy 306
Display a Reservation Policy by ID 308
Update a Reservation Policy 310
Delete a Reservation Policy 312
Working with Key Pairs 314
Get a Key Pair List 314
Create a Key Pair 319
Query a Key Pair 322
Update a Key Pair 323
Delete a Key Pair 326
Working with Network Profiles 328
Get a Network Profile List 328
Create a Network Profile 367
Query a Network Profile 370
Update a Network Profile 392
Delete a Network Profile 395
4
Filtering and Formatting REST API Information 397
5
Related Tools and Documentation 398
Using the vRealize Automation REST API Reference 398
Using vRealize CloudClient 399
Using the API Explorer 399
Install the API Explorer 399
Choosing Your Mode of Operation 400
Log in with the API Explorer 403
Suppress Log Files 405
Creating an API Explorer Command Using Supplied curl Examples 405
Using Third Party Tools 406
Programming Guide
VMware, Inc. 4