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
Syntax for Displaying All Available Resource Types
You can use the REST API catalog service to display all the resource types that are available on the system.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/catalog-service/api/consumer/resourceTypes
$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.
Output
The command output contains property names and values based on the command input parameters.
Property Description
id Species the unique identier of this resource.
iconId Species an icon for this request based on the requested object type.
resourceTypeRef Species the resource type.
name Species the resource name.
description Species the resource description.
status Species the resource status.
catalogItem Species the catalog item that denes the service this resource is based on.
requestId Species the request ID that provisioned this resource.
providerBinding Species the provider binding.
owners Species the owners of this resource.
organization Species the subtenant or tenant that owns this resource.
dateCreated Species the data and time at which the resource was created.
lastUpdated Species the date and time at which the resource was most recently modied.
hasLease Returns true if the resource is subject to a lease.
lease Displays the resource's current lease as start and end time stamps.
leaseForDisplay Species the resource's current lease, #getLease, with time units synchronized with
#getCosts.
hasCosts Returns true if the resource is subject to per-time costs.
costs Displays an optional rate of the cost charges for the resource.
costToDate Displays an optional rate of the current cost charges for the resource.
totalCost Displays an optional rate of the cost charges for the entire lease period.
parentResourceRef Displays the parent of this resource.
childResources Displays the children of this resource.
operations Species the sequence of available operations that can be performed on this resource.
Chapter 3 REST API Use Cases
VMware, Inc. 75