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
8. cpu: 1
9. memory:
10. min: 512
11. max: 8192
12. os_type: Linux
13. os_distribution: rhel
14. action: LinkedClone
15. archive_days: 1
16. provisioning_workflow: {id: CloneWorkflow}
17. lease_days: 3
18. source_machine_name: cbp_centos_63_x86
19. cost_center: sales
20. _cluster: 2
21. apache:
22. type: Software.Apache
23. data:
24. host: '${_resource~web}'
25. http_port: 8080
Each of these lines plays an important role in the blueprint structure.
n
Lines 1 - 4 represent possible top level blueprint elds that provide identifying information. The only
other possible eld is description. The semantics of these elds is straightforward, but you can refer to
java.classBlueprintDocument for more information.
n
Line 4 represents the blueprint components. Each key under components is the ID of the component
that must be unique under the current blueprint.
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 denes the component conguration and appears under all component data.
n
Key is the name of the property or eld of that component. This can be a property dened in
the corresponding component type.
Property or field option Example
A property dened in the corresponding
component type
cpu
A reserved property
_cluster
Custom property
cost_center
n
The value of the eld can be directly dened as in cpu: 2, or you can denes its constraints, as
done for the memory eld in the example.
n
Line 16 shows how to specify and entity reference eld. 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 eld to come from another eld.
n
_resource is a reserved eld 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.
Programming Guide
352 VMware, Inc.