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
Output
The command output contains property names and values based on the command input parameters.
Table 3โ24. Import and Export Response Body Parameters
Parameter Description
importStatus Over all status of the import/validation operation, one failure in import/validation result
guarantees failed status. Values are as follows:
n
Successful - Denotes the successful import or validation status at a particular
component or package level.
n
Partial - Denotes a scenario that warrants a system level warning. Alerts the user
about a possible error condition that the proposed action may create.
n
Failed - Denotes an import or validation failure at a particular component package
level.
data Set of collected content import/validation results populated by the provider. The Content
import operation result collection is the set of content that passed or failed:
n
entityType - (string) The ID for the entity being imported.
n
entitytId - (string) Unique content ID within the ๎le system.
n
messageKey - (string)
n
logLevel - The logging level to use for any errors that occur.
n
message - Information returned by the provider.
n
entityName - (anyType) Name of the entity being imported.
Example Curl Command
The following command imports a ๎le called XaaSContent.zip.
curl --insecure -X POST -H"Authorization: Bearer $token"-H"Content-Type: multipart/form-data"-
F"file=@XaaSContent.zip"-F"prefix=prefix_"-F"prefixOnlyConflicting=true"' https://$host/advanced-
designer-service/api/content/bundles'
Example: JSON Output
The output of the command is a message indicating the status and details of the import operation.
{
"importStatus" : "SUCCESSFUL",
"data" : [ {
"logLevel" : "INFO",
"entityType" : "com.vmware.vcac.designer.service.domain.ServiceBlueprint",
"entityId" : "4740aa54-61e6-47d7-945f-0bb50ff153c8",
"entityName" : "XaaSBlueprint",
"messageKey" : "import.blueprint.success",
"message" : "Success"
} ]
}
Chapter 3 REST API Use Cases
VMware, Inc. 355