3.1.5.3 GatewayPools

The GatewayPools resource aggregates a set of gateways resources into a single pool. It contains an array of gateways that provide the infrastructure needed to service VirtualGateways instances with differentiated services for tenant virtual networks.

A gateway pool usually consists of gateways that provide services, such as IPsec, Generic Routing Encapsulation (GRE) ([RFC2784]) or a Forwarding (L3) gateway. A gateway pool can also be created for different categories of customers or resellers. After a gateway pool is created, gateways of identical type and capacity can be added to the pool. Each tenant can be assigned one or more gateway pools from which its connections are serviced. Gateways in a gateway pool can service multiple tenants.

It is invoked through the following URI.

 https://<url>/networking/v1/GatewayPools/{resourceId}

url: The address or name of the REST server of the Network Controller.

resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, v1 or later, in the URI.

The following HTTP methods can be performed on this resource.

HTTP method	Section	Description
PUT	3.1.5.3.1.1	Create a new GatewayPools resource or update an existing GatewayPools resource.
GET	3.1.5.3.1.2	Get one GatewayPools resource.
GET ALL	3.1.5.3.1.3	List all GatewayPools resources in the Network Controller.
DELETE	3.1.5.3.1.4	Delete a GatewayPools resource.

The following property elements are valid.

Element name	Type	Description
etag	Read-only	Specified in Common JSON Elements, section 2.2.2.
provisioningState	Read-only	Specified in Common JSON Elements, section 2.2.2.
Type	Required	Indicates the type of the role of gateway VMs in the pool. The following are valid string values: s2sIPsec s2sGre forwarding ALL
greVipSubnets	Read/write. Required if Type is equal to s2sGre or ALL.	Indicates the logical subnet from which VIPs for gateways providing GRE-based network connections.
publicIPAddresses	Read/write Optional	Indicates collection of public IP address references. These are the IPs to which external connections connect to. This is optional in case Type is s2sGre.
redundantGatewayCount	Read/write	Indicates the number of redundant gateway VMs that will be used for each VirtualGateways instance to ensure its availability. For example, in a 3+1 gateway deployment, 1 will be redundant gateway count.
gatewayCapacityKiloBitsPerSecond	Read/write	Indicates the total capacity of each gateway in the pool in kilobits per second.
Gateways	Read-only	Indicates references to collection of gateways that comprise the gateway pool.
VirtualGateways	Read-only	Indicate references to collection of VirtualGateways (that contains subscription connection information) that are dependent on the pool.