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
Procedure
1 Query the reservation policy and copy the response output to an editor.
2 Change the following information to use as the basis of the command input for this task.
n
Reservation policy name
n
Reservation policy description
n
Reservation policy type ID
3 Update the name and description values for the reservation policy ID.
The following example syntax updates the information for reservation policy ID
94d74105-831a-4598-8f42-efd590fea15c.
curl –X PUT --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/reservation-service/api/reservations/policies/94d74105-831a-4598-8f42-
efd590fea15c -d “
{
"id": "94d74105-831a-4598-8f42-efd590fea15c",
"name": "ReservationPolicyTestRename",
"description": "ReservationPolicyDescTestRename",
"reservationPolicyTypeId": "Infrastructure.Reservation.Policy.ComputeResource"
}
“
If the command is successful, the HTTP response body is empty except for a 204 No Content status
statement.
Syntax for Updating a Reservation Policy
You can use the vRealize Automation REST API reservation service to update a reservation policy.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/reservation-service/api/reservations/policies/$id
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.
HTTP body Describes the reservation policy to update.
To obtain the value, query the reservation policy and copy the response
output to an editor for use as the basis of your command input. See
“Syntax for Displaying a Reservation Policy by ID,” on page 270.
n
$id - reservation policy ID
n
$name - reservation policy name
n
$description - reservation policy description
n
$reservationPolicyTypeId - reservation policy type ID
The supported reservation policy types are
Reservation.Policy.ComputeResource and
Reservation.Policy.Storage.
Programming Guide
272 VMware, Inc.