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
Example: JSON Output
The output contains an empty HTTP response body and the following status code.
204 No Content
Working with Network Profiles
You can use the vRealize Automation IaaS proxy provider service and IPAM service REST API to create, list,
and update network proles.
You can access the following types of network prole by using the same programming calls. Dierent types
of network proles contain dierent elds.
Network Profile
Type Description
External All network proles use the elements in the object denition for external network. The network
denition species the network address conguration for the network. The external network
denition can specify:
n
Existing network addresses congured on the vSphere server. They are the external part of the
NAT and routed networks types. An external network prole can dene a range of static IP
addresses available on the external network.
n
An endpoint that allows access to IP ranges obtained from the supplied VMware internal IPAM
provider or an external IPAM provider solution that you have imported and registered in
vRealize Orchestrator, such as Infoblox IPAM, and existing network address ranges congured by
the IPAM provider software.
n
An endpoint that allows access to IP ranges obtained from the supplied VMware internal IPAM
provider or an external IPAM provider solution that you have imported and registered in
vRealize Orchestrator, such as Infoblox IPAM, and existing network address ranges congured by
the IPAM provider software.
An external network prole with a static IP range is a prerequisite for NAT and routed networks.
When you specify a NAT network prole or a Routed network prole, the base object denition for
the external network prole is used and additional denitions for the NAT or Routed network proles
are required to complete the prole.
NAT An external network that uses network address translation (NAT) to enable one set of IP addresses for
external communication and another set for internal communications. With one-to-one NAT
networks, every virtual machine is assigned an external IP address from the external network prole
and an internal IP address from the NAT network prole. With one-to-many NAT networks, all
machines share a single IP address from the external network prole for external communication.
A NAT network prole denes local and external networks that use a translation table for mutual
communication.
Routed A routed network represents a routable IP space divided across subnets that are linked together using
Distributed Logical Router (DLR). Every new routed network has the next available subnet assigned
to it and is associated with other routed networks that use the same network prole. The virtual
machines that are provisioned with routed networks that have the same routed network prole can
communicate with each other and the external network.
A routed network prole denes a routable space and available subnets.
For more information about Distributed Logical Router, see NSX Administration Guide.
Get a Network Profile List
You can use the vRealize Automation REST API to get a list of current network proles.
Prerequisites
n
Log in to vRealize Automation as a tenant administrator.
n
Verify that the host name and fully qualied domain name of the vRealize Automation instance are
available.
Chapter 3 REST API Use Cases
VMware, Inc. 287