.TH "GCLOUD_COMPUTE_HEALTH\-CHECKS_CREATE_GRPC" 1



.SH "NAME"
.HP
gcloud compute health\-checks create grpc \- create a gRPC health check to monitor load balanced instances



.SH "SYNOPSIS"
.HP
\f5gcloud compute health\-checks create grpc\fR \fINAME\fR [\fB\-\-check\-interval\fR=\fICHECK_INTERVAL\fR;\ default="5s"] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-enable\-logging\fR] [\fB\-\-grpc\-service\-name\fR=\fIGRPC_SERVICE_NAME\fR] [\fB\-\-healthy\-threshold\fR=\fIHEALTHY_THRESHOLD\fR;\ default=2] [\fB\-\-timeout\fR=\fITIMEOUT\fR;\ default="5s"] [\fB\-\-unhealthy\-threshold\fR=\fIUNHEALTHY_THRESHOLD\fR;\ default=2] [\fB\-\-global\fR\ |\ \fB\-\-region\fR=\fIREGION\fR] [\fB\-\-port\fR=\fIPORT\fR\ \fB\-\-use\-serving\-port\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fBgcloud compute health\-checks create grpc\fR is used to create a non\-legacy
health check using the gRPC protocol. You can use this health check for Google
Cloud load balancers or for managed instance group autohealing. For more
information, see the health checks overview at:
https://cloud.google.com/load\-balancing/docs/health\-check\-concepts



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fINAME\fR

Name of the gRPC health check to create.


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-check\-interval\fR=\fICHECK_INTERVAL\fR; default="5s"

How often to perform a health check for an instance. For example, specifying
\f5\fI10s\fR\fR will run the check every 10 seconds. The default value is
\f5\fI5s\fR\fR. See $ gcloud topic datetimes for information on duration
formats.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

An optional string description for the gRPC health check.

.TP 2m
\fB\-\-enable\-logging\fR

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

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

.TP 2m
\fB\-\-grpc\-service\-name\fR=\fIGRPC_SERVICE_NAME\fR

An optional gRPC service name string of up to 1024 characters to include in the
gRPC health check request. Only ASCII characters are allowed.

.TP 2m
\fB\-\-healthy\-threshold\fR=\fIHEALTHY_THRESHOLD\fR; default=2

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

.TP 2m
\fB\-\-timeout\fR=\fITIMEOUT\fR; default="5s"

If Google Compute Engine doesn't receive a healthy response from the instance by
the time specified by the value of this flag, the health check request is
considered a failure. For example, specifying \f5\fI10s\fR\fR will cause the
check to wait for 10 seconds before considering the request a failure. The
default value is \f5\fI5s\fR\fR. See $ gcloud topic datetimes for information on
duration formats.

.TP 2m
\fB\-\-unhealthy\-threshold\fR=\fIUNHEALTHY_THRESHOLD\fR; default=2

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

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-global\fR

If set, the gRPC health check is global.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

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

To avoid prompting when this flag is omitted, you can set the
\f5\fIcompute/region\fR\fR property:

.RS 2m
$ gcloud config set compute/region REGION
.RE

A list of regions can be fetched by running:

.RS 2m
$ gcloud compute regions list
.RE

To unset the property, run:

.RS 2m
$ gcloud config unset compute/region
.RE

Alternatively, the region can be stored in the environment variable
\f5\fICLOUDSDK_COMPUTE_REGION\fR\fR.

.RE
.sp
.TP 2m

These flags configure the port that the health check monitors.


.RS 2m
.TP 2m
\fB\-\-port\fR=\fIPORT\fR

The TCP port number that this health check monitors.

.TP 2m
\fB\-\-use\-serving\-port\fR

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

.RS 2m
.IP "\(bu" 2m
When health checking network endpoints in a Network Endpoint Group, use the port
specified with each endpoint. \f5\-\-use\-serving\-port\fR must be used when
using a Network Endpoint Group as a backend as this flag specifies the
\f5portSpecification\fR option for a Health Check object.
.IP "\(bu" 2m
When health checking other backends, use the port of the backend service.
.RE
.sp


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha compute health\-checks create grpc
.RE

.RS 2m
$ gcloud beta compute health\-checks create grpc
.RE