collect-diagnostics¶

Description¶

returns details of running command

Synopsis¶

  collect-diagnostics
--environment-name <value>
--database-name <value>
--end-time <value>
[--start-time <value>]
[--destination <value>]
[--case-number <value>]
[--bundle-size-bytes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-name (string)

The name of the environment.

--database-name (string)

The name of the database.

--end-time (string)

The end time (in ISO 8601 format) of the period to collection statistics for.

--start-time (string)

The start time (in ISO 8601 format) of the period to collection statistics for.

--destination (string)

Destination of the created diagnostics bundle.

Possible values:

• UPLOAD_TO_CLOUDERA

• DOWNLOAD

--case-number (string)

The CSH case number to associate the bundle.

--bundle-size-bytes (integer)

Bundle size limit.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

diagnosticsBundle -> (object)

Describe a diagnostics bundle.

id -> (string)

Identifier for each bundle collection.

crn -> (string)

The object on which diagnostics was collected.

startTime -> (datetime)

Start time.

endTime -> (datetime)

The end time, if the command is finished.

destination -> (string)

Destination of the created diagnostics bundle.

caseNumber -> (string)

CSH case number.

status -> (string)

A status of the diagnostics collection process.

result -> (string)

If this is a download, a link to the download location of the bundle.

Form Factors¶

public