REST Resource: projects.locations.networks

Stay organized with collections Save and categorize content based on your preferences.

Resource: Network

A Network.

JSON representation 
{
  "name": string,
  "id": string,
  "type": enum (Type),
  "ipAddress": string,
  "macAddress": [
    string
  ],
  "state": enum (State),
  "vlanId": string,
  "cidr": string,
  "vrf": {
    object (VRF)
  },
  "labels": {
    string: string,
    ...
  },
  "servicesCidr": string,
  "reservations": [
    {
      object (NetworkAddressReservation)
    }
  ],
  "pod": string,
  "mountPoints": [
    {
      object (NetworkMountPoint)
    }
  ],
  "jumboFramesEnabled": boolean,
  "gatewayIp": string
}
Fields
name

string

Output only. The resource name of this Network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: projects/{project}/locations/{location}/networks/{network}
id

string

An identifier for the Network, generated by the backend.
type

enum (Type)

The type of this network.
ipAddress

string

IP address configured.
macAddress[]

string

List of physical interfaces.
state

enum (State)

The Network state.
vlanId

string

The vlan id of the Network.
cidr

string

The cidr of the Network.
vrf

object (VRF)

The vrf for the Network.
labels

map (key: string, value: string)

Labels as key value pairs.
servicesCidr

string

IP range for reserved for services (e.g. NFS).
reservations[]

object (NetworkAddressReservation)

List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
pod

string

Output only. Pod name.
mountPoints[]

object (NetworkMountPoint)

Input only. List of mount points to attach the network to.
jumboFramesEnabled

boolean

Whether network uses standard frames or jumbo ones.
gatewayIp

string

Output only. Gateway ip address.

State

The possible states for this Network.

Enums
STATE_UNSPECIFIED The Network is in an unknown state.
PROVISIONING The Network is provisioning.
PROVISIONED The Network has been provisioned.
DEPROVISIONING The Network is being deprovisioned.
UPDATING The Network is being updated.

VRF

A network VRF.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "qosPolicy": {
    object (QosPolicy)
  },
  "vlanAttachments": [
    {
      object (VlanAttachment)
    }
  ]
}
Fields
name

string

The name of the VRF.
state

enum (State)

The possible state of VRF.
qosPolicy

object (QosPolicy)

The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
vlanAttachments[]

object (VlanAttachment)

The list of VLAN attachments for the VRF.

State

The possible states for this VRF.

Enums
STATE_UNSPECIFIED The unspecified state.
PROVISIONING The vrf is provisioning.
PROVISIONED The vrf is provisioned.

QosPolicy

QOS policy parameters.

JSON representation 
{
  "bandwidthGbps": number
}
Fields
bandwidthGbps

number

The bandwidth permitted by the QOS policy, in gbps.

VlanAttachment

VLAN attachment details.

JSON representation 
{
  "peerVlanId": string,
  "peerIp": string,
  "routerIp": string,
  "pairingKey": string,
  "qosPolicy": {
    object (QosPolicy)
  },
  "id": string
}
Fields
peerVlanId

string (int64 format)

The peer vlan ID of the attachment.
peerIp

string

The peer IP of the attachment.
routerIp

string

The router IP of the attachment.
pairingKey

string

Input only. Pairing key.
qosPolicy

object (QosPolicy)

The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
id

string

Immutable. The identifier of the attachment within vrf.

NetworkAddressReservation

A reservation of one or more addresses in a network.

JSON representation 
{
  "startAddress": string,
  "endAddress": string,
  "note": string
}
Fields
startAddress

string

The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
endAddress

string

The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, endAddress and startAddress will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
note

string

A note about this reservation, intended for human consumption.

NetworkMountPoint

Mount point for a network.

JSON representation 
{
  "instance": string,
  "logicalInterface": string,
  "defaultGateway": boolean,
  "ipAddress": string
}
Fields
instance

string

Instance to attach network to.
logicalInterface

string

Logical interface to detach from.
defaultGateway

boolean

Network should be a default gateway.
ipAddress

string

Ip address of the server.

Methods

get

 Get details of a single network.

list

 List network in a given project and location.

patch

 Update details of a single network.