Class RouterNat

Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

Inheritance

object

RouterNat

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Compute.alpha.Data

Assembly: Google.Apis.Compute.alpha.dll

Syntax

public class RouterNat : IDirectResponseSchema

Properties

AutoNetworkTier

The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.

Declaration

[JsonProperty("autoNetworkTier")]
public virtual string AutoNetworkTier { get; set; }

Property Value

Type	Description
string

DrainNatIps

A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

Declaration

[JsonProperty("drainNatIps")]
public virtual IList<string> DrainNatIps { get; set; }

Property Value

Type	Description
IList<string>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnableDynamicPortAllocation

Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config.

Declaration

[JsonProperty("enableDynamicPortAllocation")]
public virtual bool? EnableDynamicPortAllocation { get; set; }

Property Value

Type	Description
bool?

EnableEndpointIndependentMapping

Declaration

[JsonProperty("enableEndpointIndependentMapping")]
public virtual bool? EnableEndpointIndependentMapping { get; set; }

Property Value

Type	Description
bool?

EndpointTypes

List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM

Declaration

[JsonProperty("endpointTypes")]
public virtual IList<string> EndpointTypes { get; set; }

Property Value

Type	Description
IList<string>

IcmpIdleTimeoutSec

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

Declaration

[JsonProperty("icmpIdleTimeoutSec")]
public virtual int? IcmpIdleTimeoutSec { get; set; }

Property Value

Type	Description
int?

LogConfig

Configure logging on this NAT.

Declaration

[JsonProperty("logConfig")]
public virtual RouterNatLogConfig LogConfig { get; set; }

Property Value

Type	Description
RouterNatLogConfig

MaxPortsPerVm

Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.

Declaration

[JsonProperty("maxPortsPerVm")]
public virtual int? MaxPortsPerVm { get; set; }

Property Value

Type	Description
int?

MinPortsPerVm

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

Declaration

[JsonProperty("minPortsPerVm")]
public virtual int? MinPortsPerVm { get; set; }

Property Value

Type	Description
int?

Name

Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Nat64Subnetworks

List of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above.

Declaration

[JsonProperty("nat64Subnetworks")]
public virtual IList<RouterNatSubnetworkToNat64> Nat64Subnetworks { get; set; }

Property Value

Type	Description
IList<RouterNatSubnetworkToNat64>

NatIpAllocateOption

Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

Declaration

[JsonProperty("natIpAllocateOption")]
public virtual string NatIpAllocateOption { get; set; }

Property Value

Type	Description
string

NatIps

A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

Declaration

[JsonProperty("natIps")]
public virtual IList<string> NatIps { get; set; }

Property Value

Type	Description
IList<string>

Rules

A list of rules associated with this NAT.

Declaration

[JsonProperty("rules")]
public virtual IList<RouterNatRule> Rules { get; set; }

Property Value

Type	Description
IList<RouterNatRule>

SourceSubnetworkIpRangesToNat

Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.

Declaration

[JsonProperty("sourceSubnetworkIpRangesToNat")]
public virtual string SourceSubnetworkIpRangesToNat { get; set; }

Property Value

Type	Description
string

SourceSubnetworkIpRangesToNat64

Specify the Nat option for NAT64, which can take one of the following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only.

Declaration

[JsonProperty("sourceSubnetworkIpRangesToNat64")]
public virtual string SourceSubnetworkIpRangesToNat64 { get; set; }

Property Value

Type	Description
string

Subnetworks

A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

Declaration

[JsonProperty("subnetworks")]
public virtual IList<RouterNatSubnetworkToNat> Subnetworks { get; set; }

Property Value

Type	Description
IList<RouterNatSubnetworkToNat>

TcpEstablishedIdleTimeoutSec

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

Declaration

[JsonProperty("tcpEstablishedIdleTimeoutSec")]
public virtual int? TcpEstablishedIdleTimeoutSec { get; set; }

Property Value

Type	Description
int?

TcpTimeWaitTimeoutSec

Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

Declaration

[JsonProperty("tcpTimeWaitTimeoutSec")]
public virtual int? TcpTimeWaitTimeoutSec { get; set; }

Property Value

Type	Description
int?

TcpTransitoryIdleTimeoutSec

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

Declaration

[JsonProperty("tcpTransitoryIdleTimeoutSec")]
public virtual int? TcpTransitoryIdleTimeoutSec { get; set; }

Property Value

Type	Description
int?

Type

Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
string

UdpIdleTimeoutSec

Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

Declaration

[JsonProperty("udpIdleTimeoutSec")]
public virtual int? UdpIdleTimeoutSec { get; set; }

Property Value

Type	Description
int?

Implements

IDirectResponseSchema