3.1.5.4 gateways
A gateways resource is the computing resource that provides gateway services to one or more virtualNetworks resources. The configuration in this resource is the generic configuration that provides gateway services to the virtualNetwork resources.
It is invoked through the following URI.
-
https://<url>/networking/v1/gateways/{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 |
Create a new gateways resource or update an existing gateways resource. |
|
|
GET |
Get one gateways resource. |
|
|
GET ALL |
List all gateways resources in the Network Controller. |
|
|
DELETE |
Delete a gateways 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. |
|
VirtualGateways |
Read-only |
Reference to collection of tenants' virtual gateways. This helps in enumerating the tenants that are dependent on this gateway. |
|
configurationState |
Optional Read-only |
Indicates the last known running state of this gateway. See configurationState specification in section 2.2.4. More details are given in the section for the GET operation section 3.1.5.4.1.2. |
|
virtualServer |
Read-only |
Reference to the virtual server that acts as a gateway. |
|
totalCapacity |
Read-only |
Indicates total bandwidth capacity of the gateway when it was provisioned. This value indicates plain-text processing capacity. For example, for a 6-core VM the value will be 6 Gbps. |
|
connections |
Read/write |
Indicates a reference to collection of all the connections on the gateway. |
|
pool |
Required |
Indicates a reference to the GatewayPools resource the gateway is part of. |
|
networkInterfaces |
Required Read/write |
Indicates the external and internal network interfaces that the gateways resource operates on. Both references MUST be present on both read and write. The references cannot be changed after the gateways resource is created. |
|
networkInterfaces.externalNetworkInterface |
Read/Write |
A resource reference to a network interface with precisely one IP configuration on a logical network. |
|
networkInterfaces.internalNetworkInterface |
Read/Write |
A resource reference to a network interface without any IP configurations. |
|
type |
Read-only |
Indicates the type of pool – All, IKEv2, GRE, or forwarding. |
|
bgpConfig |
Read/write |
Indicates the BGP peering information required for peering with Top-of-Rack (ToR) router for GRE Gateway. |
|
bgpConfig.extASNumber |
Read/write |
Extended (4-byte) Autonomous System Number (ASN) of the local BGP Router in XX.YY format. |
|
bgpConfig.bgpPeer |
Read/write |
Indicates information of the BGP peer. |
|
bgpConfig.bgpPeer.peerIP |
Read/write |
IP address of the peer, in this case the ToR. |
|
bgpConfig.bgpPeer.peerExtAsNumber |
Read/write |
Extended (4-byte) ASN of the peer BGP router in XX.YY format. |