describe-server-setting¶

Description¶

Get the DWX server settings. This method can be used from DWX Private Cloud version 1.4.1.

Synopsis¶

  describe-server-setting
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

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

settings -> (array)

The list of the server settings.

item -> (object)

A DWX server setting.

Form Factors: private

configurationName -> (string)

The name of the setting in human readable format.

configurationKey -> (string)

The identifier of the setting.

enabled -> (boolean)

The state of the setting.

description -> (string)

The description of the setting.

requiresUpdate -> (array)

Indicates update requirements for the change to take effect.

item -> (string)

Indicates an update requirement for the change to take effect. ENVIRONMENT - Means that the environments need to be updated/recreated for the setting change to take effect. DBC - Means that the Database Catalogs need an update/recreation. VW - Means that the Virtual Warehouses need the update/recreation. VIZ - Means that the Dataviz need the update/recreation.

Form Factors: private

Form Factors¶

private