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
Example: Example: JSON Output
The export command returns a message that indicates whether or not the package was exported. A
successful export produces a package.zip exported to the specied location. The returned message is '200 -
Successes' with the Package or 404 - 'Not Found' if it does not nd a package with provided ID.
Syntax for Validating a Content Bundle Before Importing
You can use the REST API content management service to validate a content bundle before importing to a
critical system. VMware recommends that you validate all packages before importing them to any system.
Input
You can use optional request parameters with your query URL to customize the returned content.
Table 3‑18. Package Validation Parameters
Name Description Type
le The name of the package le to be validated query
resolution mode The resolution mode to be used for performing validation
when the same entity exists in the system. Valid values are
SKIP, OVERWRITE. SKIP will not update the existing entity
with the new content while OVERWRITE will update the old
entity with the new data. In case the resolution mode is not
explicitly provided the default mode OVERWRITE will be
used for conict resolution.
query
Output
The package validation response body contains the following parameters.
Table 3‑19. Import and Export Response Body Parameters
Parameter Description
contentImportStatus Over all status of the import/validation operation, one failure in import/validation result
guarantees failed status. Values are as follows:
n
Success - Denotes the successful import or validation status at a particular
component or package level.
n
Failed - Denotes an import or validation failure at a particular component package
level.
n
Warning - Denotes a scenario that warrants a system level warning. Alerts the user
about a possible error condition that the proposed action may create.
contentImportResults 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. If failed the
errors are populated in ContentImportError. Properties are as follows:
n
contentId - (string) Unique content ID within the le system.
n
contentName - (anyType) Name of the content being imported.
n
contentTypeId - (string) The ID for the content type being exported. This matches the
folder structure in the exported zip.
n
contentImportStatus - Track the failed or succeeded status of an entity.
n
messages - Information returned by the provider.
n
contentImportErrors - Set of errors returned by the provider.
Programming Guide
348 VMware, Inc.