Update Vsan Hcl Configuration

Update vSAN HCL configuration

Request

URI

PATCH

https://{api_host}/v1/vsan-hcl/configuration

COPY

Request Body

VsanHclConfiguration of type(s) application/json

Required

{
    "autoDownloadEnabled": false,
    "outOfDateErrorThreshold": 0,
    "outOfDateWarningThreshold": 0,
    "pollingInterval": 0,
    "pollingEnabled": false
}

boolean

autoDownloadEnabled

Required

Flag to indicate if auto download of vSAN HCL data is enabled or disabled

integer As int32 As int32

outOfDateErrorThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as error

integer As int32 As int32

outOfDateWarningThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as warning

integer As int64 As int64

pollingInterval

Required

Interval in minutes at which availability of new vSAN HCL data will be checked

boolean

pollingEnabled

Required

Flag to indicate if polling for vSAN HCL data is enabled or disabled

Responses

200

Returns VsanHclConfiguration of type(s) application/json

{
    "autoDownloadEnabled": false,
    "outOfDateErrorThreshold": 0,
    "outOfDateWarningThreshold": 0,
    "pollingInterval": 0,
    "pollingEnabled": false
}

boolean

autoDownloadEnabled

Required

Flag to indicate if auto download of vSAN HCL data is enabled or disabled

integer As int32 As int32

outOfDateErrorThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as error

integer As int32 As int32

outOfDateWarningThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as warning

integer As int64 As int64

pollingInterval

Required

Interval in minutes at which availability of new vSAN HCL data will be checked

boolean

pollingEnabled

Required

Flag to indicate if polling for vSAN HCL data is enabled or disabled

202

Accepted

Returns VsanHclConfiguration of type(s) application/json

{
    "autoDownloadEnabled": false,
    "outOfDateErrorThreshold": 0,
    "outOfDateWarningThreshold": 0,
    "pollingInterval": 0,
    "pollingEnabled": false
}

boolean

autoDownloadEnabled

Required

Flag to indicate if auto download of vSAN HCL data is enabled or disabled

integer As int32 As int32

outOfDateErrorThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as error

integer As int32 As int32

outOfDateWarningThreshold

Required

Duration after which vSAN HCL data will be flagged as out of date with severity as warning

integer As int64 As int64

pollingInterval

Required

Interval in minutes at which availability of new vSAN HCL data will be checked

boolean

pollingEnabled

Required

Flag to indicate if polling for vSAN HCL data is enabled or disabled

404

vSAN HCL configuration not found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.