The API for Advanced Networking Services provides support for developers who are building interactive clients of vCloud Air for network configuration and who are using a RESTful application development style.

A collection of JSON and XML documents represents and defines the objects on which the RESTful API for Advanced Networking Services operates.

Note

The vCloud Air API supports only the XML data format for the vCloud Air API; whereas, the Advanced Networking Services API supports both the JSON and XML data formats. This programmer's guide provides all examples for the Advanced Networking Services API by using the JSON data format and VMware recommends that developers using this API create clients supporting JSON.

For the RESTful API, you must know these things:

The set of objects that the API supports, and what they represent. For example, what is a distributedFirewall object?

How the API represents these objects. For example, what is the JSON schema for the edge firewall rule set? What do the individual elements and attributes represent?

How the client refers to an object on which it wants to operate. For example, what is a managed object ID?

To answer these questions, you look at the API resource schemas. These schemas define a number of JSON types, many of which are extended by other types. The elements defined in these schemas, along with their attributes and composition rules (minimum and maximum number of elements or attributes, or the prescribed hierarchy with which elements can be nested) represent the data structures of objects.

This programming guide provides information about the schema for the following objects.

Objects Accessible by the Advanced Networking Services API

For this object…

See the following chapter or topic…

applicationGroups

"Firewalls"

applicationSet

"Firewalls"

certificate

Virtual Private Networks"

csr

Virtual Private Networks"

dhcp

DHCP Service

distributedFirewall

"Firewalls"

Note

Configuring the distributed firewall is possible only when you have the vCloud Air Dedicated Cloud subscription service.

edgeFirewall

"Firewalls"

ipsec

Virtual Private Networks"

ipSet

"Firewalls"

lbApplicationProfile

"Load Balancer"

lb

"Load Balancer"

macSet

"Firewalls"

nat

NAT Configuration

routing

"Routing"

sslvpn

Virtual Private Networks"

syslog

Manage the System Logs for an Edge Gateway