Creates a new policy-based route in a given project and location.

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: networkconnectivity1 --scope <scope> projects locations-global-policy-based-routes-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource's name of the PolicyBasedRoute.

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:

PolicyBasedRoute:
  create-time: string
  description: string
  filter:
    dest-range: string
    ip-protocol: string
    protocol-version: string
    src-range: string
  interconnect-attachment:
    region: string
  kind: string
  labels: { string: string }
  name: string
  network: string
  next-hop-ilb-ip: string
  next-hop-other-routes: string
  priority: integer
  self-link: string
  update-time: string
  virtual-machine:
    tags: [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 . create-time=ipsum
    • Output only. Time when the policy-based route was created.
  • description=ipsum
    • Optional. An optional description of this resource. Provide this field when you create the resource.
  • filter dest-range=est
    • Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.
  • ip-protocol=gubergren
    • Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.
  • protocol-version=ea
    • Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.

  • src-range=dolor

    • Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4.

  • ..interconnect-attachment region=lorem

    • Optional. Cloud region to install this policy-based route on interconnect attachment. Use all to install it on all interconnect attachments.

  • .. kind=eos

    • Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.
  • labels=key=labore
    • User-defined labels.
    • the value will be associated with the given key
  • name=sed
    • Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}
  • network=duo
    • Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.
  • next-hop-ilb-ip=sed
    • Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.
  • next-hop-other-routes=no
    • Optional. Other routes that will be referenced to determine the next hop of the packet.
  • priority=86
    • Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.
  • self-link=kasd
    • Output only. Server-defined fully-qualified URL for this resource.
  • update-time=et
    • Output only. Time when the policy-based route was updated.
  • virtual-machine tags=sed
    • Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.
    • Each invocation of this argument appends the given value to the array.

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 policy-based-route-id=string

    • Required. Unique id for the policy-based route to create.

  • -p request-id=string

    • Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

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").