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
n
Whenever a property binding refers to output of some other component, it creates an implicit
dependency between components.
Available Constraints
To dene constraints in any blueprint eld. create a new hierarchy or level in YAML, and use any of the keys
below to dene constraints and their values.
Table 3‑21. Blueprint Constraints
ID or Key Corresponding CAFE Constraint Description
default com.vmware.vcac.platform.content.facets.DefaultValueB
ehavior
Species the value for a eld.
xed com.vmware.vcac.platform.content.facets.FixedValueCo
nstraint
Species the value for a eld that
cannot be overridden at request or
reuse time.
mandatory com.vmware.vcac.platform.content.facets.MandatoryCo
nstraint
Indicates that the eld is mandatory.
min com.vmware.vcac.platform.content.facets.MinValueCon
straint
Indicates the minimum value for a
numeric eld.
max com.vmware.vcac.platform.content.facets.MaxValueCon
straint
Indicates the maximum value for a
numeric eld.
minLength com.vmware.vcac.platform.content.facets.MinLengthCo
nstraint
Indicates the minimum length for a
string eld.
maxLength com.vmware.vcac.platform.content.facets.MaxLengthCo
nstraint
Indicates the maximum length for a
string eld.
minCardinality com.vmware.vcac.platform.content.facets.MinLengthCo
nstraint
Indicates the minimum cardinality for
an array eld.
maxCardinality com.vmware.vcac.platform.content.facets.MaxCardinalit
yConstraint
Indicates the maximum cardinality for
an array eld.
increment com.vmware.vcac.platform.content.facets.IncrementBeh
avior
Indicates the step or increment for a
numeric eld.
regex com.vmware.vcac.platform.content.facets.RegexpConstr
aint
Indicates the valid regex for a string
eld.
secured com.vmware.vcac.platform.content.facets.EncryptedBeh
avior
Indicates whether the eld is to be
treated securely.
valid_values com.vmware.vcac.platform.content.elds.PermissibleVal
ueList
Denes the valid values for a eld.
Manage XaaS Content with Import and Export
You can use the content management service to import and export everything as a service (XaaS) content.
XaaS services are integrated with the API content management service, and all commands that work with
other content types also work with XaaS content. Though these XaaS services may be deprecated in a future
vRealize Automation release, they are still available for users to migrate XaaS content into
vRealize Automation.
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 qualied domain name of the vRealize Automation instance are
available.
Chapter 3 REST API Use Cases
VMware, Inc. 353