Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



Target Pool Commands

Contents

addtargetpool

addtargetpool                Create a new target pool to handle network load
                             balancing.

                             Usage: gcutil [--global_flags] addtargetpool
                             [--command_flags] <target-pool-name>

                             Flags for addtargetpool:

gcutil_lib.gcutil_flags:
  --session_affinity: <NONE|CLIENT_IP|CLIENT_IP_PROTO>: Specifies the session
    affinity option for the connection. Options include:
    NONE: connections from the same client IP may go to any VM in the target
    pool
    CLIENT_IP: connections from the same client IP will go to the same VM in the
    target pool;
    CLIENT_IP_PROTO: connections from the same client IP with the same IP
    protocol will go to the same VM in the targetpool.
    (default: 'NONE')

gcutil_lib.target_pool_cmds:
  --backup_pool: Together with --failover_ratio, this flag defines the fallback
    behavior of the target pool (primary pool) to be created by this command: if
    the ratio of the healthy VMs in the primary pool is at or below
    --failover_ratio, traffic arriving at the load-balanced IP will be directed
    to the backup pool.
  --description: An optional Target Pool description
    (default: '')
  --failover_ratio: If set, --backup_pool must also be set to point to an
    existing target pool in the same region. They together define the fallback
    behavior of the target pool (primary pool) to be created by this command: if
    the ratio of the healthy VMs in the primary pool is at or below this number,
    traffic arriving at the load-balanced IP will be directed to the backup
    pool. If not set, the traaffic will be directed the VMs in this pool in the
    "force" mode, where traffic will be spread to the healthy VMs with the best
    effort, or to all VMs when no VM is healthy.
    (a number)
  --health_checks: Specifies a HttpHealthCheck resource to use to determine the
    health of VMs in this pool. If no health check is specified, traffic will be
    sent to all instances in this target pool as if the instances were healthy,
    but the health status of this pool will appear as unhealthy as a warning
    that this target pool does not have a health check.
    (default: '')
    (a comma separated list)
  --instances: [Required] Specifies a list of instances that will receive
    traffic directed to this target pool. Each entry must be specified by the
    instance name (e.g., '--instances=myinstance') or a relative or
    fully-qualified path to the instance (e.g.,
    '--instances=<zone>/instances/myotherinstance'). To specify multiple
    instances, provide them as comma-separated entries. All instances in one
    target pool must belong to the same region as the target pool. Instances do
    not need to exist at the time the target pool is created and can be created
    afterwards.
    (default: '')
    (a comma separated list)
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

addtargetpoolhealthcheck

addtargetpoolhealthcheck     Add a health check to an existing target pool.

                             Usage: gcutil [--global_flags]
                             addtargetpoolhealthcheck [--command_flags]
                             <target-pool-name>

                             Flags for addtargetpoolhealthcheck:

gcutil_lib.target_pool_cmds:
  --health_check: [Required] Specifies the healthCheck resource to add to the
    target pool. For example, '--health_check=myhealthcheck'.
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

deletetargetpool

deletetargetpool             Delete one or more target pools.

                             If multiple target pool names are specified, the
                             target pool will be deleted in parallel.

                             Usage: gcutil [--global_flags] deletetargetpool
                             [--command_flags] <target-pool-name-1> ...
                             <target-pool-name-n>

                             Flags for deletetargetpool:

gcutil_lib.command_base:
  -f,--[no]force: Override the "Delete target pool" prompt
    (default: 'false')

gcutil_lib.target_pool_cmds:
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

gettargetpool

gettargetpool                Get a target pool.

                             Usage: gcutil [--global_flags] gettargetpool
                             [--command_flags] <target-pool-name>

                             Flags for gettargetpool:

gcutil_lib.target_pool_cmds:
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

gettargetpoolhealth

gettargetpoolhealth          Get the health status of a VM instance in a target
                             pool.

                             Usage: gcutil [--global_flags] gettargetpoolhealth
                             [--command_flags] <target-pool-name>

                             Flags for gettargetpoolhealth:

gcutil_lib.target_pool_cmds:
  --instances: Specifies the list of instance resources in a target pool to
    query for health status. Each entry must be specified by the instance name
    (e.g., '--instances=<instance>') or a relatively or fully qualified path to
    the instance instance (e.g., '--instances=<zone>/instances/<instance>'). To
    specify multiple instances, provide them as comma-separated entries. If
    empty, gcutil will query the status of each instance in the pool by doing an
    API call for each instance.
    (default: '')
    (a comma separated list)
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

listtargetpools

listtargetpools              List the target pools for a project.

                             Usage: gcutil [--global_flags] listtargetpools
                             [--command_flags]

                             Flags for listtargetpools:

gcutil_lib.command_base:
  --columns: A comma-separated list of the desired columns to display. If 'all'
    is specified, then all possible columns will be included. Valid columns are
    <all|name|description|region>.
    (a comma separated list)
  --[no]fetch_all_pages: Deprecated flag.
    (default: 'true')
  --filter: Filter expression for filtering listed resources. See gcutil
    documentation for syntax of the filter expression here:
    http://developers.google.com/compute/docs/gcutil/tips#filtering
  --max_results: Maximum number of items to list [Default is to fetch all].
    (a positive integer)

gcutil_lib.gcutil_flags:
  --sort_by: <name|-name|region|-region>: Sort output results by the given field
    name. Field names starting with a "-" will lead to a descending order.

gcutil_lib.target_pool_cmds:
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

removetargetpoolhealthcheck

removetargetpoolhealthcheck  Remove a health check from a target pool.

                             Usage: gcutil [--global_flags]
                             removetargetpoolhealthcheck [--command_flags]
                             <target-pool-name>

                             Flags for removetargetpoolhealthcheck:

gcutil_lib.target_pool_cmds:
  --health_check: [Required] Specifies the healthCheck resource to remove. For
    example, '--health_check=myhealthcheck'.
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

settargetpoolbackup

settargetpoolbackup          Set the backup pool of an existing target pool.

                             Usage: gcutil [--global_flags] settargetpoolbackup
                             [--command_flags] <target-pool-name>

                             Flags for settargetpoolbackup:

gcutil_lib.target_pool_cmds:
  --backup_pool: --backup_pool and --failover_ratio must either be both set or
    not set. If not set, existing backup pool will be removed from the target
    pool, which will disable the fallback behavior of the primary target pool.
    If set, the backup pool of the primary target pool will be replaced by this
    value.
  --failover_ratio: --failover_ratio and --backup_pool must either be both set
    or not set. If not set, existing failover ratio will be removed from the
    target pool, which will disable the fallback behavior of the primary target
    pool. If set, the failover ratio of the primary target pool will be replaced
    by this value.
    (a number)
  --region: [Required] The region for this request.

gflags:
  --flagfile: Insert flag definitions from the given file into the command line.
    (default: '')
  --undefok: comma-separated list of flag names that it is okay to specify on
    the command line even if the program does not define a flag with that name.
    IMPORTANT: flags in this list that have arguments MUST use the --flag=value
    format.
    (default: '')

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.