Update details of a single network.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: baremetalsolution2 --scope <scope> projects locations-networks-patch ...

Required Scalar Argument

• <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}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Network:
  cidr: string
  gateway-ip: string
  id: string
  ip-address: string
  jumbo-frames-enabled: boolean
  labels: { string: string }
  mac-address: [string]
  name: string
  pod: string
  services-cidr: string
  state: string
  type: string
  vlan-id: string
  vrf:
    name: string
    qos-policy:
      bandwidth-gbps: number
    state: string
  vrf-attachment: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . cidr=ipsum
  • The cidr of the Network.
• gateway-ip=sed
  • Output only. Gateway ip address.
• id=ut
  • An identifier for the Network, generated by the backend.
• ip-address=gubergren
  • IP address configured.
• jumbo-frames-enabled=true
  • Whether network uses standard frames or jumbo ones.
• labels=key=ipsum
  • Labels as key value pairs.
  • the value will be associated with the given key
• mac-address=ipsum
  • List of physical interfaces.
  • Each invocation of this argument appends the given value to the array.
• name=est
  • 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}
• pod=gubergren
  • Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
• services-cidr=ea
  • IP range for reserved for services (e.g. NFS).
• state=dolor
  • The Network state.
• type=lorem
  • The type of this network.
• vlan-id=eos
  • The vlan id of the Network.
• vrf name=labore
  • The name of the VRF.

• qos-policy bandwidth-gbps=0.46093367968783205

  • The bandwidth permitted by the QOS policy, in gbps.

• .. state=sed

  • The possible state of VRF.

• .. vrf-attachment=no

  • Optional. The name of a pre-existing Vrf that the network should be attached to. Format is vrfs/{vrf}.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • The list of fields to update. The only currently supported fields are: labels, reservations, vrf.vlan_attachments

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").