7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
Table 13‑1. Blueprint Constraints (Continued)
ID or Key Corresponding CAFE Constraint Description
min com.vmware.vcac.platform.content.facets.MinValueConstraint Indicates the minimum value for a numeric
field.
max com.vmware.vcac.platform.content.facets.MaxValueConstrain
t
Indicates the maximum value for a
numeric field.
minLength com.vmware.vcac.platform.content.facets.MinLengthConstrai
nt
Indicates the minimum length for a string
field.
maxLength com.vmware.vcac.platform.content.facets.MaxLengthConstra
int
Indicates the maximum length for a string
field.
minCardinality com.vmware.vcac.platform.content.facets.MinLengthConstrai
nt
Indicates the minimum cardinality for an
array field.
maxCardinality com.vmware.vcac.platform.content.facets.MaxCardinalityCon
straint
Indicates the maximum cardinality for an
array field.
increment com.vmware.vcac.platform.content.facets.IncrementBehavior Indicates the step or increment for a
numeric field.
regex com.vmware.vcac.platform.content.facets.RegexpConstraint Indicates the valid regex for a string field.
secured com.vmware.vcac.platform.content.facets.EncryptedBehavior Indicates whether the field is to be treated
securely.
valid_values com.vmware.vcac.platform.content.fields.PermissibleValueLis
t
Defines the valid values for a field.
Prerequisites for Importing and Exporting Content
Satisfy the following conditions before performing any tasks for this use case.
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 appliance name and fully qualified domain name of the vRealize Automation instance
are available.
n
Verify that you have a valid HTTP bearer token that matches your login credentials. See Chapter 2
REST API Authentication.
List Supported Content Types Example
GET /api/provider/contenttypes displays a list of supported content types.
Supported Content Types
A content type describes content that you can import or export using the content management service.
Content types contain metadata about the content provider and the content itself, such as type
information or service type ID. Usually the content provider supplies this information.
Programming Guide
VMware, Inc. 345