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
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$host/catalog-service/api/consumer/resourceType
$host Specifies the host name and fully qualified domain name or IP address of the
vRealize Automation identity server.
$token Specifies a valid HTTP bearer token with necessary credentials.
Filter by the following resource types:
n
Infrastructure.Machine
n
Infrastructure.AppServic
n
Infrastructure.Cloud
n
Infrastructure.Physical
n
Infrastructure.vApp
n
Infrastructure.Virtual
Output
The command output contains property names and values based on the command input parameters.
Property Description
id Specifies the unique identifier of this resource.
iconId Specifies an icon for this request based on the requested object type.
resourceTypeRef Specifies the resource type.
name Specifies the resource name.
description Specifies the resource description.
status Specifies the resource status.
catalogItem Specifies the catalog item that defines the service this resource is based on.
requestId Specifies the request ID that provisioned this resource.
providerBinding Specifies the provider binding.
owners Species the owners of this resource.
organization Specifies the subtenant or tenant that owns this resource.
dateCreated Specifies the data and time at which the resource was created.
lastUpdated Specifies the date and time at which the resource was most recently modified.
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 Specifies the resource's current lease, #getLease, with time units synchronized with #getCosts.
Programming Guide
VMware, Inc. 76