WireGroup

A resource that represents a group of redundant wires.

JSON representation 
{
  "kind": string,
  "selfLink": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "endpoints": {
    string: {
      object (Endpoint)
    },
    ...
  },
  "wireProperties": {
    object (WireProperties)
  },
  "adminEnabled": boolean,
  "wires": [
    {
      object (Wire)
    }
  ],
  "topology": {
    object (WireGroupTopology)
  },
  "reconciling": boolean
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#wireGroups

for wire groups.
id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.
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])? 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.
description

string

An optional description of the wire group.
endpoints

map (key: string, value: object (Endpoint))

A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an

    Endpoint

    object.
wireProperties

object (WireProperties)

Properties for all wires in the wire group.
adminEnabled

boolean

Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.
wires[]

object (Wire)

The single/redundant wire(s) managed by the wire group.
topology

object (WireGroupTopology)

Topology details for the wire group configuration.
reconciling

boolean

[Output Only] Indicates whether there are wire changes yet to be processed.

Endpoint

A logical endpoint for the wire group. An endpoint represents a metro that contains redundant Interconnect connections. A wire group is created between two endpoints.

JSON representation 
{
  "interconnects": {
    string: {
      object (Interconnect)
    },
    ...
  }
}
Fields
interconnects

map (key: string, value: object (Interconnect))

A map that contains the redundant Interconnect connections. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an

    Interconnect

    object.

Interconnect

The redundant Interconnect connections for this endpoint.

JSON representation 
{
  "interconnect": string,
  "vlanTags": [
    integer
  ]
}
Fields
interconnect

string

Required. An Interconnect connection. You can specify the connection as a partial or full URL. If the connection is in a different project from the cross-site network, use a format that specifies the project. See the following examples of partial and full URLs:

vlanTags[]

integer

Required. To configure the wire group for VLAN mode, enter a VLAN tag, which is a number from 2 to 4093. You can autoallocate a tag by entering 0. To configure the wire group for port mode, enter -1. Review the following guidelines:

  • A VLAN tag must be unique for an Interconnect connection across all attachments and wire groups.
  • Both endpoints of a wire must use the same VLAN tag value.
  • Single wire and redundant type wire groups must have only one VLAN tag.
  • Port mode pseudowires must have a single VLAN tag with a value of -1 for both endpoints.
  • Box and cross type wire groups must have two VLAN tags. The first is for the same-zone pseudowire, and the second is for the cross-zone pseudowire.

WireProperties

The properties of a wire.

JSON representation 
{
  "bandwidthUnmetered": string,
  "bandwidthAllocation": enum (BandwidthAllocation),
  "faultResponse": enum (FaultResponse)
}
Fields
bandwidthUnmetered

string (int64 format)

The unmetered bandwidth in Gigabits per second, using decimal units. 10 is 10 Gbps, 100 is 100 Gbps. The bandwidth must be greater than 0.
bandwidthAllocation

enum (BandwidthAllocation)

The configuration of the bandwidth allocation, one of the following:

  • ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group.
  • SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group.
faultResponse

enum (FaultResponse)

Response when a fault is detected in a pseudowire:

  • NONE: default.
  • DISABLE_PORT: set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.

BandwidthAllocation

The configuration of a wire's bandwidth allocation.

Enums
ALLOCATE_PER_WIRE Configures a separate unmetered bandwidth allocation (and associated charges) for each wire in the group.
SHARED_WITH_WIRE_GROUP This is the default behavior. Configures one unmetered bandwidth allocation for the wire group. The unmetered bandwidth is divided equally across each wire in the group, but dynamic throttling reallocates unused unmetered bandwidth from unused or underused wires to other wires in the group.

FaultResponse

Response when a fault is detected in a pseudowire.

Enums
NONE Default.
DISABLE_PORT Set the port line protocol down when inline probes detect a fault. This setting is only permitted on port mode pseudowires.

Wire

A pseudowire that connects two Interconnect connections.

JSON representation 
{
  "label": string,
  "endpoints": [
    {
      object (Endpoint)
    }
  ],
  "wireProperties": {
    object (WireProperties)
  },
  "adminEnabled": boolean
}
Fields
label

string

[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1, where:

  • ENDPOINT_A

    and

    ENDPOINT_B

    : are the labels that you entered as map keys when you specified the wire group endpoint objects.

  • CONNECTION_A1

    and

    CONNECTION_B1

    : are the labels that you entered as map keys when you specified the wire group Interconnect objects.
endpoints[]

object (Endpoint)

Wire endpoints are specific Interconnect connections.
wireProperties

object (WireProperties)

[Output Only] Properties of the wire.
adminEnabled

boolean

[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.

Endpoint

Wire endpoints are specific Interconnect connections.

JSON representation 
{
  "interconnect": string,
  "vlanTag": integer
}
Fields
interconnect

string
vlanTag

integer

WireGroupTopology

Topology details for the wire group.

JSON representation 
{
  "endpoints": [
    {
      object (Endpoint)
    }
  ]
}
Fields
endpoints[]

object (Endpoint)

Topology details for all endpoints in the wire group.

Endpoint

Topology details for a single wire group endpoint.

JSON representation 
{
  "label": string,
  "city": string
}
Fields
label

string

Endpoint label from the wire group.
city

string

The InterconnectLocation.city (metropolitan area designator) that all interconnects are located in.