7.1
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
vRealize Automation customers often experiment with system artifacts such as catalog items, XaaS
services, resource actions, and IaaS blueprints in their development or staging environments. When
appropriate, users need to move these artifacts to their production environments.
Note You cannot import/export approval policies or entitlements. Also, you cannot import or export any
content that is in a draft state.
The examples herein are shown as Curl commands for consistency with other similar examples, though
the REST API content management service provides a convenient mechanism for moving such artifacts
between systems using the CloudClient interface. With CloudClient, there is no need to set heading
values, including the Authorization header. The $host//$servicename/api is eliminated from the URL
and the service name becomes a separate parameter. For example, consumer/entitled
CatalogItems/{id}/request/template. See Using vRealize CloudClient.
Some parameters on the API request are common to all content management service import and export
commands. These parameters are listed below.
Parameter Description
$host The host name and fully qualified domain name or IP address of the
vRealize Automation identity server.
$token A valid HTTP bearer token that includes necessary credentials.
Note When exporting content, values of secure strings and encrypted properties are excluded by
default. You can add the --secure false parameter to commands to export these properties as plain
text with your content. Secure strings and encrypted properties are typically used as property holders for
passwords.
The following examples illustrate the types of requests that you might use in typical import export
situations.
Prerequisites
n
Log in to vRealize Automation with an appropriate role. For example: Software Architect, Application
Architect, Infrastructure Architecture or some combination of these depending on the need.
n
Verify that the host name and fully qualified domain name of the vRealize Automation instance are
available.
n
Verify that there is a valid HTTP bearer token that matches your login credentials. See Chapter 2
REST API Authentication.
Programming Guide
VMware, Inc. 360