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
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 3
REST API Authentication.
Procedure
1 (Optional) Use the REST API content service to display a list of supported vRealize Automation
content types. Typically, this step is required only if you are not familiar with the content on your
system or if you need to verify the content.
A content type describes the content that you can import or export using the content management
service.
$curl --insecure -s -H "Content-Type: application/json" -H "Authorization: Bearer
$token" https://$host/content-management-service/api/provider/contenttypes
2 Display a list of available content in vRealize Automation.
Content includes published artifacts such as blueprints, software, properties etc.
$curl --insecure -s -H"Content-Type: application/json" -H "Authorization: Bearer
$token" https://$host/content-management-service/api/contents
3 If applicable, you can also apply filtering by content type.
This example sets the contentTypeId to composite-blueprint.
Programming Guide
VMware, Inc. 372