7.1
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
Network Profile
Type Description
External All network profiles use the elements in the object definition for external network. The network definition
specifies the network address configuration for the network. The external network definition can specify:
n
Existing network addresses configured on the vSphere server. They are the external part of the NAT and
routed networks types. An external network profile can define 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 configured 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 configured by the IPAM provider software.
An external network profile with a static IP range is a prerequisite for NAT and routed networks.
When you specify a NAT network profile or a Routed network profile, the base object definition for the external
network profile is used and additional definitions for the NAT or Routed network profiles are required to
complete the profile.
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 profile and an internal IP address from
the NAT network profile. With one-to-many NAT networks, all machines share a single IP address from the
external network profile for external communication.
A NAT network profile defines 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 profile. The virtual machines that are
provisioned with routed networks that have the same routed network profile can communicate with each other
and the external network.
A routed network profile defines 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 profiles.
Prerequisites
n
Log in to vRealize Automation as a tenant administrator.
n
Verify that the host name and fully qualified domain name of the vRealize Automation instance are
available.
n
Verify that you have a valid HTTP bearer token that matches your login credentials. See Chapter 2
REST API Authentication.
Programming Guide
VMware, Inc. 311