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
n
Lines 5 - 19 correspond to the Web component. The following appear under any component data:
n
The key type is mandatory and must refer to the component type on which the current
component is based.
n
The key dependsOn is optional and contains the list of component IDs current component
depends on. Component dependencies are extracted automatically based on property binding
expressions. In most cases, you do not need to explicitly specify component dependencies.
n
The key data defines the component configuration and appears under all component data.
n
Key is the name of the property or field of that component. This can be a property defined in
the corresponding component type.
Property or field option Example
A property defined in the corresponding component type
cpu
A reserved property
_cluster
Custom property
cost_center
n
The value of the field can be directly defined as in cpu: 2, or you can defines its constraints,
as done for the memory field in the example.
n
Line 16 shows how to specify and entity reference field. The available sub-keys are id and label.
n
Line 24 depicts several things.
n
${<field_path>} provides a way to express the value of a field to come from another field.
n
_resource is a reserved field ID that captures the output of entire blueprint. Output from each
component is exposed under the same key as component ID. So in this case, host value is set to
the output of the web component thus saying the apache component needs to be hosted on
machine provisioned from the web component.
n
Whenever a property binding refers to output of some other component, it creates an implicit
dependency between components.
Available Constraints
To define constraints in any blueprint field. create a new hierarchy or level in YAML, and use any of the
keys below to define constraints and their values.
Table 13‑1. Blueprint Constraints
ID or Key Corresponding CAFE Constraint Description
default com.vmware.vcac.platform.content.facets.DefaultValueBehav
ior
Specifies the value for a field.
fixed com.vmware.vcac.platform.content.facets.FixedValueConstrai
nt
Specifies the value for a field that cannot
be overridden at request or reuse time.
mandatory com.vmware.vcac.platform.content.facets.MandatoryConstrai
nt
Indicates that the field is mandatory.
Programming Guide
VMware, Inc. 344