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
Parameter Description
n
ROUTED
n
IPAMEndpointId
If you are querying an external network prole that uses
external IPAM, shows the endpoint ID for the external
IPAM provider.
n
subnetMask:
Species the subnet mask.
n
gatewayAddress:
Species the IP address of the network gateway.
n
primaryDnsAddress:
Species the IP address of the primary DNS server. This
parameter is only available for external, NAT, and routed
network proles.
n
secondaryDnsAddress:
Species the IP address of a secondary DNS server. This
parameter is only available for external, NAT, and routed
network proles.
n
dnsSux:
Species the DNS sux. This parameter is only available
for external, NAT, and routed network proles.
n
dnsSearchSux:
Species the DNS search sux. This parameter is only
available for external, NAT, and routed network proles.
n
primaryWinsAddress:
Species the IP address of the primary Wins server. This
parameter is only available for external, NAT, and routed
network proles.
n
secondaryWinsAddress:
Species the IP address of secondary Wins server. This
parameter is only available for external, NAT, and routed
network proles.
n
dhcpStartIPAddress:
Species the start IP address of the DHCP server. This
parameter is only supported by NAT network proles.
n
dhcpEndIPAddress:
Species the end IP address of the DHCP server. This
parameter is only supported by NAT network proles.
n
leaseTimeInSeconds:
Species the lease time for the DHCP server. This
parameter is only supported by NAT network proles.
n
baseIP:
Species the base IP address. This parameter is only
supported by routed network proles.
Metadata Species the following paging-related data:
n
Size: Species the maximum number of rows per page.
n
totalElement: Species the number of rows returned. This
parameter is not output when you query for a single
prole.
n
totalPages: Species the total number of pages of data
available.
n
Number: Species the current page number.
Chapter 3 REST API Use Cases
VMware, Inc. 311