Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Scopes
You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform.
You can set the scope for this method like this: notebooks1 --scope <scope> projects locations-instances-diagnose ...
Required Scalar Argument
- <name> (string)
- Required. Format:
projects/{project_id}/locations/{location}/instances/{instance_id}
- Required. Format:
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
DiagnoseInstanceRequest:
diagnostic-config:
copy-home-files-flag-enabled: boolean
gcs-bucket: string
packet-capture-flag-enabled: boolean
relative-path: string
repair-flag-enabled: boolean
timeout-minutes: integer
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r .diagnostic-config copy-home-files-flag-enabled=true
- Optional. Enables flag to copy all
/home/jupyter
folder contents
- Optional. Enables flag to copy all
gcs-bucket=et
- Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (
gs://$GCS_BUCKET
). Permissions: User Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account attached to VM. Google Managed Notebooks: - storage.buckets.writer: Must be given to the project's service account or user credentials attached to VM depending on authentication mode. Cloud Storage bucket Log file will be written togs://$GCS_BUCKET/$RELATIVE_PATH/$VM_DATE_$TIME.tar.gz
- Required. User Cloud Storage bucket location (REQUIRED). Must be formatted with path prefix (
packet-capture-flag-enabled=false
- Optional. Enables flag to capture packets from the instance for 30 seconds
relative-path=dolore
- Optional. 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 bucket (
gs://$GCS_BUCKET/$DATE_$TIME.tar.gz
) Example of full path where Log file will be written:gs://$GCS_BUCKET/$RELATIVE_PATH/
- Optional. 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 bucket (
-
repair-flag-enabled=false
- Optional. Enables flag to repair service for instance
-
.. timeout-minutes=99
- Optional. Maxmium amount of time in minutes before the operation times out.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").