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
}
},
{
"key": "resourcePool",
"value": {
"type": "entityRef",
"componentId": null,
"classId": "ResourcePools",
"id": "4e51fabc-19e8-4e79-b413-d52309b3bb62",
"label": "CoreDev"
}
}]
}
}
”
The following output is returned based on the command input.
If the command is successful, the HTTP response body is empty except for a 204 No Content
status statement.
Syntax for Updating a Reservation
You can use the vRealize Automation REST API reservation service to update an existing reservation.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/reservation-service/api/reservations/$reservationId
Method Put
$host Species the host name and fully qualied domain name or IP
address of the vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary credentials.
$reservationId Species the unique identier of the reservation to update. For
information about how to obtain the reservation ID, see “Syntax for
Displaying a List of Reservations,” on page 249.
HTTP body Contains the JSON information for the reservation, including the
updated data for the parameters that you want to update.
Most of this JSON string information is obtained by displaying the
existing details of the $reservationId. See “Syntax for Verifying a
Reservation and Geing Reservation Details,” on page 236. The rest
of the JSON string information is obtained by using an API
command to get the ID of the parameter you want to update.
For example, to update the reservation to use a dierent compute
resource than the one currently specied, replace the
computeResource value of the exiting reservation with a new
computeResource value in the command's HTTP input.
Output
If the command is successful, the HTTP response body is empty except for a 204 No Content status
statement.
Chapter 3 REST API Use Cases
VMware, Inc. 259