gcloud-help/gcloud/beta/network-connectivity/policy-based-routes/create

NAME
    gcloud beta network-connectivity policy-based-routes create - create a new
        policy-based route

SYNOPSIS
    gcloud beta network-connectivity policy-based-routes create
        POLICY_BASED_ROUTE --network=NETWORK [--async]
        [--description=DESCRIPTION] [--destination-range=DESTINATION_RANGE]
        [--ip-protocol=IP_PROTOCOL] [--labels=[KEY=VALUE,...]]
        [--priority=PRIORITY]
        [--protocol-version=PROTOCOL_VERSION; default="IPV4"]
        [--source-range=SOURCE_RANGE]
        [--interconnect-attachment-region=INTERCONNECT_ATTACHMENT_REGION
          | --tags=[TAGS,...]]
        [--next-hop-ilb-ip=NEXT_HOP_ILB_IP
          | --next-hop-other-routes=NEXT_HOP_OTHER_ROUTES]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (BETA) Create a new policy-based route with the given name.

EXAMPLES
    To create a policy-based route with the name my-pbr to route all traffic in
    default network to an internal load balancer with IP 10.0.0.1, run:

        $ gcloud beta network-connectivity policy-based-routes create \
            my-pbr --network="projects/my-project/global/networks/default" \
            --next-hop-ilb-ip=10.0.0.1

POSITIONAL ARGUMENTS
     Policy based route resource - Name of the policy-based route to be
     created. This represents a Cloud resource. (NOTE) Some attributes are not
     given arguments in this group but can be set in other ways.

     To set the project attribute:
      ◆ provide the argument policy_based_route on the command line with a
        fully specified name;
      ◆ provide the argument --project on the command line;
      ◆ set the property core/project.

     This must be specified.

       POLICY_BASED_ROUTE
          ID of the policy based route or fully qualified identifier for the
          policy based route.

          To set the policy_based_route attribute:
          ▸ provide the argument policy_based_route on the command line.

REQUIRED FLAGS
     --network=NETWORK
        Fully-qualified URL of the network that this route applies to. E.g.
        projects/my-project/global/networks/my-network

OPTIONAL FLAGS
     --async
        Return immediately, without waiting for the operation in progress to
        complete.

     --description=DESCRIPTION
        Optional description of this resource. Provide this field when you
        create the resource.

     --destination-range=DESTINATION_RANGE
        Destination IP range of outgoing packets that this policy-based route
        applies to.

     --ip-protocol=IP_PROTOCOL
        IP protocol that this policy-based route applies to. Valid values are
        TCP, UDP, and ALL. Default is ALL.

     --labels=[KEY=VALUE,...]
        List of label KEY=VALUE pairs to add.

        Keys must start with a lowercase character and contain only hyphens
        (-), underscores (_), lowercase characters, and numbers. Values must
        contain only hyphens (-), underscores (_), lowercase characters, and
        numbers.

     --priority=PRIORITY
        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. Note the priority of
        policy-based route is always higher than other types of route (e.g.
        static routes/advanced routes)

     --protocol-version=PROTOCOL_VERSION; default="IPV4"
        Internet protocol versions that this policy-based route applies to.
        Valid values are IPV4, and IPV6. Default is IPV4'. PROTOCOL_VERSION
        must be one of: *ipv4*, *ipv6*, *protocol-version-unspecified*.

     --source-range=SOURCE_RANGE
        Source IP range of outgoing packets that this policy-based route
        applies to.

     At most one of these can be specified:

       --interconnect-attachment-region=INTERCONNECT_ATTACHMENT_REGION
          Cloud region to install this policy-based route on interconnect
          attachment. Use all to install it on all interconnect attachments.
          Note if both --tags and --interconnect-attachment-region are not set,
          then the policy-based route will be installed in all network
          endpoints, including VMs, VPNs, and Interconnect attachements, in the
          network.

       --tags=[TAGS,...]
          List of VM instance tags that this route applies to. VM instances
          that have ANY of tags specified here installs this route. Note if
          both --tags and --interconnect-attachment-region are not set, then
          the policy-based route will be installed in all endpoints, including
          VMs, VPNs, and Interconnect attachements, in the network.

     At most one of these can be specified:

       --next-hop-ilb-ip=NEXT_HOP_ILB_IP
          IP of a global access enabled L4 ILB that should be the next hop to
          handle packets.

       --next-hop-other-routes=NEXT_HOP_OTHER_ROUTES
          Next hop should be other routes that handle packets. This effectively
          excludes matching packets being applied on other policy-based routes
          with a lower priority. NEXT_HOP_OTHER_ROUTES must be one of:
          default-routing, other-routes-unspecified.

GCLOUD WIDE FLAGS
    These flags are available to all commands: --access-token-file, --account,
    --billing-project, --configuration, --flags-file, --flatten, --format,
    --help, --impersonate-service-account, --log-http, --project, --quiet,
    --trace-token, --user-output-enabled, --verbosity.

    Run $ gcloud help for details.

API REFERENCE
    This command uses the networkconnectivity/v1beta API. The full
    documentation for this API can be found at:
    https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest

NOTES
    This command is currently in beta and might change without notice. These
    variants are also available:

        $ gcloud network-connectivity policy-based-routes create

        $ gcloud alpha network-connectivity policy-based-routes create