gcloud alpha compute health-checks create https - create a HTTPS health check to monitor load balanced instances

gcloud alpha compute health-checks create httpsNAME[--check-interval=CHECK_INTERVAL; default="5s"][--description=DESCRIPTION][--enable-logging][--healthy-threshold=HEALTHY_THRESHOLD; default=2][--host=HOST][--proxy-header=PROXY_HEADER; default="NONE"][--request-path=REQUEST_PATH; default="/"][--response=RESPONSE][--source-regions=REGION,…,[…]][--timeout=TIMEOUT; default="5s"][--unhealthy-threshold=UNHEALTHY_THRESHOLD; default=2][--weight-report-mode=WEIGHT_REPORT_MODE][--global    |--region=REGION][--port=PORT; default=80--port-name=PORT_NAME--use-serving-port][GCLOUD_WIDE_FLAG …]

NAME

Name of the HTTPS health check to create.

--check-interval=CHECK_INTERVAL; default="5s"

How often to perform a health check for an instance. For example, specifying10s will run the check every 10 seconds.The default value is5s. See $gcloud topic datetimes forinformation on duration formats.

--description=DESCRIPTION

An optional string description for the HTTPS health check.

--enable-logging

Enable logging of health check probe results to Stackdriver. Logging is disabledby default.

Use --no-enable-logging to disable logging.

--healthy-threshold=HEALTHY_THRESHOLD; default=2

The number of consecutive successful health checks before an unhealthy instanceis marked as healthy. The default is 2.

--host=HOST

The value of the host header used for the health check. If unspecified, GoogleCloud sets the host header to the IP address of the load balancer's forwardingrule.

--proxy-header=PROXY_HEADER; default="NONE"

The type of proxy protocol header to be sent to the backend.PROXY_HEADER must be one of:

NONE

No proxy header is added.

PROXY_V1

Adds the header "PROXY UNKNOWN\r\n".

--request-path=REQUEST_PATH; default="/"

The request path that this health check monitors. For example,/healthcheck. The default value is``/´´.

--response=RESPONSE

When empty, status code of the response determines health. When not empty,presence of specified string in first 1024 characters of response bodydetermines health. Only ASCII characters allowed.

--source-regions=REGION,…,[…]

Define the list of Google Cloud regions from which health checks are performed.This option is supported only for global health checks that will be referencedby DNS routing policies. If specified, the --check-interval field should be atleast 30 seconds. The --proxy-header and --request fields (for TCP healthchecks) are not supported with this option.

If --source-regions is specified for a health check, then that health checkcannot be used by a backend service or by a managed instance group (forautohealing).

--timeout=TIMEOUT; default="5s"

If Google Compute Engine doesn't receive a healthy response from the instance bythe time specified by the value of this flag, the health check request isconsidered a failure. For example, specifying10s will cause the check to wait for 10seconds before considering the request a failure. The default value is5s. See $gcloud topic datetimes forinformation on duration formats.

--unhealthy-threshold=UNHEALTHY_THRESHOLD; default=2

The number of consecutive health check failures before a healthy instance ismarked as unhealthy. The default is 2.

--weight-report-mode=WEIGHT_REPORT_MODE

Defines whether Weighted Load Balancing is enabled.WEIGHT_REPORT_MODE must be one of:ENABLE,DISABLE,DRY_RUN.

At most one of these can be specified:

--global

If set, the HTTPS health check is global.

--region=REGION

Region of the HTTPS health check to create. If not specified, you might beprompted to select a region (interactive mode only).

To avoid prompting when this flag is omitted, you can set thecompute/region property:

gcloudconfigsetcompute/regionREGION

A list of regions can be fetched by running:

gcloudcomputeregionslist

To unset the property, run:

gcloudconfigunsetcompute/region

Alternatively, the region can be stored in the environment variableCLOUDSDK_COMPUTE_REGION.

These flags configure the port that the health check monitors. If none isspecified, the default port of 80 is used. If both--port and--port-name are specified,--port takes precedence.

--port=PORT; default=80

The TCP port number that this health check monitors.

--port-name=PORT_NAME

The port name that this health check monitors. By default, this is empty.

--use-serving-port

If given, use the "serving port" for health checks:

• When health checking network endpoints in a Network Endpoint Group, use the portspecified with each endpoint.--use-serving-port must be used whenusing a Network Endpoint Group as a backend as this flag specifies theportSpecification option for a Health Check object.
• When health checking other backends, use the port or named port of the backendservice.

Run$gcloud help for details.