6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- 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
- Requesting a Machine By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
Parameter Description
Links Specifies an array of link objects, each of which contains the
following parts:
n
rel
Specifies the name of the link.
n
Self refers to the object that was returned or requested.
n
First, Previous, Next, and Last refer to corresponding
pages of pageable lists.
n
Specifies the application or service that determines the
other names.
n
href
Specifies the URL that produces the result.
Content Specifies an array of data rows, each of which represents one of the
tenant objects returned in a pageable list. Each tenant object can
contain the following information:
n
@type:
Specifies one of the following network profile type values:
n
ExternalNetworkProfile
n
NATNetworkProfile
n
PrivateNetworkProfile
n
RoutedNetworkProfile
n
$id:
Specifies the unique network profile identifier.
n
$name:
Specifies the network profile name.
n
createdDate:
Specifies the date and time that the network profile was created.
n
lastModifiedDate:
Specifies the date and time that the network profile was last
modified.
n
isHidden:
Specifies if the network profile is hidden from the
vRealize Automation user interface.
n
definedRanges:
Specifies the IP range array that is defined for the network
profile.
n
profileType:
Specifies the network profile type as one of the following types:
n
EXTERNAL
n
NAT
n
PRIVATE
Programming Guide
VMware, Inc. 348