7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- 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
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- 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
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
K
key pairs
creating a key pair 280
delete a key pair 286
displaying a list of key pairs 276
querying a key pair 282
updating a key pair 284
using the API to create or update 274
L
LDAP, searching for a user 29
List content service packages, syntax 345
listing provisioned resources 69
listing supported content types, syntax 335
M
machine requests
approving 50
submitting a machine request 44
machine request, approving with JSON file
input 62
managing provisioned deployments 87
N
network profiles
create IPAM external network profile 305
creating a network profile 304
deleting a network profile 316
display list 294
get a list 287
querying a network profile 309
updating a network profile 314
using an existing profile to create a different
profile type 309
network profilesx, using the API to create or
update 287
P
package, export 347
package, validation 348
POST method
requesting an HTTP bearer token 10
using with HTTP bearer tokens 9
power off 98
Q
querying a key pair 281
querying a network profile 307
querying an IP address range 316
R
request, viewing a machine request status 47
request a machine 33
requests, submitting a machine request 44
reservation policies
creating 268
deleting 273, 274
getting a list of reservation policy IDs 266
listing reservation policy IDs 265
query by ID 270
updating 271, 272
working with the reservation service 265
reservations
available reservation types for API 101
common fields 127, 147
creating 101
creating and editing reservations 101
creating a reservation 205
creating a vCloud Air reservation 214
creating a vCloudAir reservation 218
creating a vSphere reservation 209
creating an Amazon EC2 reservation 225
creating an Amazon reservation 222
deleting a reservation 264
display supported types 114
display a schema definition 135
display a vCloud Air schema definition 162
display a list of types 117
displaying a schema definition 122, 127
displaying reservation details 236
getting a valid business group ID 184
getting resource data 194
getting resource data and schema
definitions 198
getting resources schema for Amazon 197
getting a compute resource 189
getting a resources schema 193
getting a vCloud Air schema 200, 202
getting a list of reservation IDs 249
getting the subtenant identifier 184
relationship with business groups 101
relationship with subtenants 101
updating a reservation 259
using the reservation identifier 236, 259, 264
using the data and schema service 127, 147,
171
verifying a new reservation 236
resources
displaying all available resource types 75
displaying machine resources for a
provisioned machine 84
listing provisioned resource by business
groups you manage 76
listing provisioned resources by type 72
listing all provisioned resources 70
resources, managing 87
Programming Guide
364 VMware, Inc.