ForwardingRules

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

For a list of methods for this resource, see the end of this page.

Resource representations

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple.

{
  "kind": "compute#forwardingRule",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "IPAddress": string,
  "IPProtocol": string,
  "portRange": string,
  "ports": [
    string
  ],
  "target": string,
  "selfLink": string,
  "loadBalancingScheme": string,
  "subnetwork": string,
  "network": string,
  "backendService": string,
  "ipVersion": string
}
Property name Value Description Notes
IPAddress string The IP address that this forwarding rule is serving on behalf of.

Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional).

When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6.

When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule.

An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid:
  • 100.1.2.3
  • https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address
  • projects/project/regions/region/addresses/address
  • regions/region/addresses/address
  • global/addresses/address
  • address
IPProtocol string The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.

When the load balancing scheme is INTERNAL, only TCP and UDP are valid.
backendService string This field is not used for external load balancing.

For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ipVersion string The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for a global forwarding rule.
kind string [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
loadBalancingScheme string This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, EXTERNAL The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy)
name string Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
network string This field is not used for external load balancing.

For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.
portRange string This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.

Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

Some types of forwarding target have constraints on the acceptable ports:
  • TargetHttpProxy: 80, 8080
  • TargetHttpsProxy: 443
  • TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222
  • TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222
  • TargetVpnGateway: 500, 4500


ports[] list This field is used along with the backend_service field for internal load balancing.

When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule.

You may specify a maximum of up to 5 ports.

region string [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules.
subnetwork string This field is not used for external load balancing.

For internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.

If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.
target string The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object.

This field is not used for internal load balancing.

Methods

The following are valid Forwarding Rule resource methods: 

aggregatedList
Retrieves an aggregated list of forwarding rules.
delete
Deletes the specified ForwardingRule resource.
get
Returns the specified ForwardingRule resource.
insert
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
list
Retrieves a list of ForwardingRule resources available to the specified project and region.
setTarget
Changes target URL for forwarding rule. The new target should be of the same type as the old target.

Send feedback about...

Compute Engine