.TH "GCLOUD_NOTEBOOKS_RUNTIMES_DIAGNOSE" 1



.SH "NAME"
.HP
gcloud notebooks runtimes diagnose \- request for diagnose runtimes



.SH "SYNOPSIS"
.HP
\f5gcloud notebooks runtimes diagnose\fR (\fIRUNTIME\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-gcs\-bucket\fR=\fIGCS_BUCKET\fR [\fB\-\-async\fR] [\fB\-\-enable\-copy\-home\-files\fR] [\fB\-\-enable\-packet\-capture\fR] [\fB\-\-enable\-repair\fR] [\fB\-\-relative\-path\fR=\fIRELATIVE_PATH\fR] [\fB\-\-timeout\-minutes\fR=\fITIMEOUT_MINUTES\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Request for diagnose notebook runtimes.



.SH "EXAMPLES"

To diagnose an runtime, run:

.RS 2m
$ gcloud notebooks runtimes diagnose example\-runtime \e
  \-\-location=us\-central1 \-\-gcs\-bucket=gs://example\-bucket
.RE

To diagnose an runtime with a relative path:

.RS 2m
$ gcloud notebooks runtimes diagnose example\-runtime \e
  \-\-location=us\-central1 \-\-gcs\-bucket=gs://example\-bucket \e
  \-\-relative\-path=logs
.RE

To diagnose an runtime, with packet capture:

.RS 2m
$ gcloud notebooks runtimes diagnose example\-runtime \e
  \-\-location=us\-central1 \-\-gcs\-bucket=gs://example\-bucket \e
  \-\-enable\-packet\-capture
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Runtime resource \- User\-defined unique name of this runtime. The runtime name
must be 1 to 63 characters long and contain only lowercase letters, numeric
characters, and dashes. The first character must be a lowercase letter and the
last character cannot be a dash. The arguments in this group can be used to
specify the attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5runtime\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIRUNTIME\fR

ID of the runtime or fully qualified identifier for the runtime.

To set the \f5runtime\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5runtime\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Google Cloud location of this runtime
https://cloud.google.com/compute/docs/regions\-zones/#locations.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5runtime\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5notebooks/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-gcs\-bucket\fR=\fIGCS_BUCKET\fR

The Cloud Storage bucket where the log files generated from the diagnose command
will be stored. storage.buckets.writer permissions must be given to project's
service account or user credential. Format: gs://\f5{gcs_bucket}\fR


.RE
.sp

.SH "OPTIONAL FLAGS"

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

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-enable\-copy\-home\-files\fR

Enables flag to copy all \f5/home/jupyter\fR folder contents

.TP 2m
\fB\-\-enable\-packet\-capture\fR

Enables flag to capture packets from the runtime for 30 seconds

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

Enables flag to repair service for runtime

.TP 2m
\fB\-\-relative\-path\fR=\fIRELATIVE_PATH\fR

Defines the relative storage path in the Cloud Storage bucket where the
diagnostic logs will be written. Default path will be the root directory of the
Cloud Storage bucketFormat of full path:
gs://\f5{gcs_bucket}\fR/\f5{relative_path}\fR/

.TP 2m
\fB\-\-timeout\-minutes\fR=\fITIMEOUT_MINUTES\fR

Maximum amount of time in minutes before the operation times out


.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.