gcloud alpha compute health-checks create ssl

NAME
gcloud alpha compute health-checks create ssl - create a SSL health check to monitor load balanced instances
SYNOPSIS
gcloud alpha compute health-checks create sslNAME[--check-interval=CHECK_INTERVAL; default="5s"][--description=DESCRIPTION][--enable-logging][--healthy-threshold=HEALTHY_THRESHOLD; default=2][--proxy-header=PROXY_HEADER; default="NONE"][--request=REQUEST][--response=RESPONSE][--timeout=TIMEOUT; default="5s"][--unhealthy-threshold=UNHEALTHY_THRESHOLD; default=2][--global    |--region=REGION][--port=PORT; default=80--port-name=PORT_NAME--use-serving-port][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA)gcloud alpha compute health-checks create sslis used to create a non-legacy health check using the SSL protocol. You can usethis health check for Google Cloud load balancers or for managed instance groupautohealing. For more information, see the health checks overview at:https://cloud.google.com/load-balancing/docs/health-check-concepts
POSITIONAL ARGUMENTS
NAME
Name of the SSL health check to create.
FLAGS
--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 SSL 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.
--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=REQUEST
An optional string of up to 1024 characters to send once the health check TCPconnection has been established. The health checker then looks for a reply ofthe string provided in the--response field.

If--response is not configured, the health checker does not waitfor a response and regards the probe as successful if the TCP or SSL handshakewas successful.

--response=RESPONSE
An optional string of up to 1024 characters that the health checker expects toreceive from the instance. If the response is not received exactly, the healthcheck probe fails. If--response is configured, but not--request, the health checker will wait for a response anyway.Unless your system automatically sends out a message in response to a successfulhandshake, only configure--response to match an explicit--request.
--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.
At most one of these can be specified:
--global
If set, the SSL health check is global.
--region=REGION
Region of the SSL 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.
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.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudcomputehealth-checkscreatessl
gcloudbetacomputehealth-checkscreatessl

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.