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
Parameter Description
If you are creating or querying an external network profile that
uses extrernal, IPAM , specifies the endpoint ID for the external
IPAM provider. If you are creating a network profile and the
profile does not use external IPAM, code null for this value.
n
subnetMask:
Specifies the subnet mask.
n
gatewayAddress:
Specifies the IP address of the network gateway.
n
primaryDnsAddress:
Specifies the IP address of the primary DNS server. This
parameter is only available for external, NAT, and routed
network profiles.
n
secondaryDnsAddress:
Specifies the IP address of a secondary DNS server. This
parameter is only available for external, NAT, and routed
network profiles.
n
dnsSuffix:
Specifies the DNS suffix. This parameter is only available for
external, NAT, and routed network profiles.
n
dnsSearchSuffix:
Specifies the DNS search suffix. This parameter is only
available for external, NAT, and routed network profiles.
n
primaryWinsAddress:
Specifies the IP address of the primary Wins server. This
parameter is only available for external, NAT, and routed
network profiles.
n
secondaryWinsAddress:
Specifies the IP address of secondary Wins server. This
parameter is only available for external, NAT, and routed
network profiles.
n
dhcpStartIPAddress:
Specifies the start IP address of the DHCP server. This
parameter is only supported by NAT and private network
profiles.
n
dhcpEndIPAddress:
Specifies the end IP address of the DHCP server. This
parameter is only supported by NAT and private network
profiles.
n
leaseTimeInSeconds:
Specifies the lease time for the DHCP server. This parameter is
only supported by NAT and private network profiles.
Programming Guide
VMware, Inc. 311