REST Resource: networks

Resource: Network

Represents a VPC Network resource.

Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "IPv4Range": string,
  "gatewayIPv4": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "autoCreateSubnetworks": boolean,
  "subnetworks": [
    string
  ],
  "peerings": [
    {
      object (NetworkPeering)
    }
  ],
  "routingConfig": {
    object (RoutingConfig)
  },
  "mtu": integer,
  "firewallPolicy": string,
  "networkFirewallPolicyEnforcementOrder": enum (NetworkFirewallPolicyEnforcementOrder),
  "enableUlaInternalIpv6": boolean,
  "internalIpv6Range": string,
  "networkProfile": string,
  "params": {
    object (NetworkParams)
  }
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#network

for networks.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description

string

An optional description of this resource. Provide this field when you create the resource.
IPv4Range
(deprecated)

string

Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example:

192.168.0.0/16

. Provided by the client when the network is created.
gatewayIPv4

string

[Output Only] The gateway address for default routing out of the network, selected by Trusted Cloud.
autoCreateSubnetworks

boolean

Must be set to create a VPC network. If not set, a legacy network is created.

When set to true, the VPC network is created in

auto

mode. When set to false, the VPC network is created in

custom

mode.

An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.

For custom mode VPC networks, you can add subnets using the subnetworks insert method.
subnetworks[]

string

[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.
peerings[]

object (NetworkPeering)

[Output Only] A list of network peerings for the resource.
routingConfig

object (RoutingConfig)

The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
mtu

integer

Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.
firewallPolicy

string

[Output Only] URL of the firewall policy the network is associated with.
networkFirewallPolicyEnforcementOrder

enum (NetworkFirewallPolicyEnforcementOrder)

The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.
enableUlaInternalIpv6

boolean

Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from Google defined ULA prefix fd20::/20. .
internalIpv6Range

string

When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the Google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .
networkProfile

string

A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs:

params

object (NetworkParams)

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

NetworkPeering

A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Trusted Cloud Compute Engine should automatically create routes for the peering.

JSON representation 
{
  "name": string,
  "network": string,
  "state": enum (NetworkPeeringState),
  "stateDetails": string,
  "autoCreateRoutes": boolean,
  "exportCustomRoutes": boolean,
  "importCustomRoutes": boolean,
  "exchangeSubnetRoutes": boolean,
  "exportSubnetRoutesWithPublicIp": boolean,
  "importSubnetRoutesWithPublicIp": boolean,
  "peerMtu": integer,
  "stackType": enum (PeeringStackType),
  "updateStrategy": enum (UpdateStrategy),
  "connectionStatus": {
    object (ConnectionStatus)
  }
}
Fields
name

string

Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
network

string

The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
state

enum (NetworkPeeringState)

[Output Only] State for the peering, either ACTIVE or INACTIVE. The peering is ACTIVE when there's a matching configuration in the peer network.
stateDetails

string

[Output Only] Details about the current state of the peering.
autoCreateRoutes

boolean

This field will be deprecated soon. Use the

exchangeSubnetRoutes

field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Trusted Cloud Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is

ACTIVE

.
exportCustomRoutes

boolean

Whether to export the custom routes to peer network. The default value is false.
importCustomRoutes

boolean

Whether to import the custom routes from peer network. The default value is false.
exchangeSubnetRoutes

boolean

Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Trusted Cloud Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is

ACTIVE

.
exportSubnetRoutesWithPublicIp

boolean

Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.
importSubnetRoutesWithPublicIp

boolean

Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.
peerMtu

integer

[Output Only] Maximum Transmission Unit in bytes of the peer network.
stackType

enum (PeeringStackType)

Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
updateStrategy

enum (UpdateStrategy)

The update strategy determines the semantics for updates and deletes to the peering connection configuration.
connectionStatus

object (ConnectionStatus)

[Output Only] The effective state of the peering connection as a whole.

NetworkPeeringState

States for Network Peering.

Enums
INACTIVE There is no matching configuration on the peer, including the case when peer does not exist.
ACTIVE Matching configuration exists on the peer.

PeeringStackType

Enums
IPV4_ONLY This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6.
IPV4_IPV6 This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.

UpdateStrategy

Enums
UNSPECIFIED

Peerings with update strategy

UNSPECIFIED

are created with update strategy

INDEPENDENT

.
INDEPENDENT In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.
CONSENSUS Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.

ConnectionStatus

[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.

JSON representation 
{
  "updateStrategy": enum (UpdateStrategy),
  "trafficConfiguration": {
    object (TrafficConfiguration)
  },
  "consensusState": {
    object (ConsensusState)
  }
}
Fields
updateStrategy

enum (UpdateStrategy)

The update strategy determines the update/delete semantics for this peering connection.
trafficConfiguration

object (TrafficConfiguration)

The active connectivity settings for the peering connection based on the settings of the network peerings.
consensusState

object (ConsensusState)

The consensus state contains information about the status of update and delete for a consensus peering connection.

TrafficConfiguration

JSON representation 
{
  "stackType": enum (PeeringStackType),
  "importCustomRoutesFromPeer": boolean,
  "exportCustomRoutesToPeer": boolean,
  "importSubnetRoutesWithPublicIpFromPeer": boolean,
  "exportSubnetRoutesWithPublicIpToPeer": boolean
}
Fields
stackType

enum (PeeringStackType)

Which IP version(s) of traffic and routes are being imported or exported between peer networks.
importCustomRoutesFromPeer

boolean

Whether custom routes are being imported from the peer network.
exportCustomRoutesToPeer

boolean

Whether custom routes are being exported to the peer network.
importSubnetRoutesWithPublicIpFromPeer

boolean

Whether subnet routes with public IP ranges are being imported from the peer network.
exportSubnetRoutesWithPublicIpToPeer

boolean

Whether subnet routes with public IP ranges are being exported to the peer network.

ConsensusState

The status of update/delete for a consensus peering connection. Only set when

connectionStatus.update_strategy

is

CONSENSUS

or a network peering is proposing to update the strategy to

CONSENSUS

.

JSON representation 
{
  "deleteStatus": enum (DeleteStatus),
  "updateStatus": enum (UpdateStatus)
}
Fields
deleteStatus

enum (DeleteStatus)

The status of the delete request.
updateStatus

enum (UpdateStatus)

The status of the update request.

DeleteStatus

Enums
DELETE_STATUS_UNSPECIFIED
LOCAL_DELETE_REQUESTED Network admin has requested deletion of this peering connection.
PEER_DELETE_REQUESTED The peer network admin has requested deletion of this peering connection.
DELETE_ACKNOWLEDGED Both network admins have agreed this consensus peering connection can be deleted.

UpdateStatus

Enums
UPDATE_STATUS_UNSPECIFIED
IN_SYNC No pending configuration update proposals to the peering connection.
PENDING_LOCAL_ACKNOWLEDMENT The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.
PENDING_PEER_ACKNOWLEDGEMENT The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.

RoutingConfig

A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.

JSON representation 
{
  "routingMode": enum (RoutingMode),
  "bgpBestPathSelectionMode": enum (BgpBestPathSelectionMode),
  "bgpAlwaysCompareMed": boolean,
  "bgpInterRegionCost": enum (BgpInterRegionCostMode),
  "effectiveBgpAlwaysCompareMed": boolean,
  "effectiveBgpInterRegionCost": enum (BgpInterRegionCostMode)
}
Fields
routingMode

enum (RoutingMode)

The network-wide routing mode to use. If set to

REGIONAL

, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to

GLOBAL

, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.
bgpBestPathSelectionMode

enum (BgpBestPathSelectionMode)

The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be

LEGACY

(default) or

STANDARD

.
bgpAlwaysCompareMed

boolean

Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.
bgpInterRegionCost

enum (BgpInterRegionCostMode)

Allows to define a preferred approach for handling inter-region cost in the selection process when using the

STANDARD

BGP best path selection algorithm. Can be

DEFAULT

or

ADD_COST_TO_MED

.
effectiveBgpAlwaysCompareMed

boolean

[Output Only] Effective value of the

bgpAlwaysCompareMed

field.
effectiveBgpInterRegionCost

enum (BgpInterRegionCostMode)

[Output Only] Effective value of the

bgpInterRegionCost

field.

RoutingMode

Option for customer to set what kind of routing behavior routers in this network should use.

Enums
REGIONAL
GLOBAL

BgpBestPathSelectionMode

Choice of the BGP Best Path Selection algorithm.

Enums
LEGACY
STANDARD

BgpInterRegionCostMode

Choice of the behavior of inter-regional cost and MED in the BPS algorithm.

Enums
DEFAULT
ADD_COST_TO_MED

NetworkFirewallPolicyEnforcementOrder

Enums
AFTER_CLASSIC_FIREWALL
BEFORE_CLASSIC_FIREWALL

NetworkParams

Additional network parameters.

JSON representation 
{
  "resourceManagerTags": {
    string: string,
    ...
  }
}
Fields
resourceManagerTags

map (key: string, value: string)

Tag keys/values directly bound to this resource. Tag keys and values have the same definition as resource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { : } or Namespaced format { : }. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.

Methods

addPeering

 The method compute.v1.NetworksService.AddPeering is not available in Trusted Cloud by S3NS.

delete

 The method compute.v1.NetworksService.Delete is not available in Trusted Cloud by S3NS.

get

 The method compute.v1.NetworksService.Get is not available in Trusted Cloud by S3NS.

getEffectiveFirewalls

 The method compute.v1.NetworksService.GetEffectiveFirewalls is not available in Trusted Cloud by S3NS.

insert

 The method compute.v1.NetworksService.Insert is not available in Trusted Cloud by S3NS.

list

 The method compute.v1.NetworksService.List is not available in Trusted Cloud by S3NS.

listPeeringRoutes

 The method compute.v1.NetworksService.ListPeeringRoutes is not available in Trusted Cloud by S3NS.

patch

 The method compute.v1.NetworksService.Patch is not available in Trusted Cloud by S3NS.

removePeering

 The method compute.v1.NetworksService.RemovePeering is not available in Trusted Cloud by S3NS.

requestRemovePeering

 The method compute.v1.NetworksService.RequestRemovePeering is not available in Trusted Cloud by S3NS.

switchToCustomMode

 The method compute.v1.NetworksService.SwitchToCustomMode is not available in Trusted Cloud by S3NS.

updatePeering

 The method compute.v1.NetworksService.UpdatePeering is not available in Trusted Cloud by S3NS.