7.0
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
- 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
- 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
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Parameter Description
$schemaclassid Specifies the schema class ID.
This example illustrates how to use the securityGroups field of an
Amazon reservation type as an example. The schema class ID of an
Amazon reservation is Infrastructure.Reservation.Cloud.Amazon.
For this example, the input value for $schemaclassid is
Infrastructure.Reservation.Cloud.Amazon.
$fieldId Specifies the field ID of the resource.
For example, the field ID for the resource pool is securityGroups. For
this example, the input value for $fieldId is securityGroups.
HTTP body Contains information about dependencies.
Because the dependency of this permissible value field is
computeResource, you must provide a dependency definition in the HTTP
body.
Output
The command output contains property names and values based on the command input parameters.
Property Description
values An array of data rows, each of which represents one of the security group objects returned in a
pageable list. Each security group object contains an underlyingValue and label entry.
underlyingValue JSON string representing one permissible value for a field:
n
type -- data type of entityRef, complexRef, or primary
n
component ID -- componentID
n
classId -- schema class ID of current data type
n
id -- unique security group ID
n
label -- security group label
label Specifies the security groups label. This value matches the underlyingValue value.
Example: curl Command
The following example command displays resource schema security group information.
curl --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/reservation-service/api/data-
service/schema/Infrastructure.Reservation.Cloud.Amazon/default/securityGroups/values -d “
{
"text": "",
"dependencyValues": {
"entries": [{
"key": "computeResource",
"value": {
"type": "entityRef",
"componentId": null,
"classId": "ComputeResource",
"id": "9d1a3b5a-7162-4a5a-85b7-ec1b2824f554"
}
Programming Guide
VMware, Inc. 209