VsanDataDrivenAPIAction

The vSAN Cluster health action is a set of instructions that guide vSphere and storage administrators on how to address potential health problems detected by the vSAN health service.

The data-driven API action, in this case, refers to the action button in the user interface, which is defined by vSAN remediation rules and does not require any code changes from the UI side. This approach offers flexibility as it allows administrators to invoke any APIs provided by the vSAN service using the button in the UI.

This structure may be used only with operations rendered under /vsan.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "actionId": "string",
    "actionLabel": {
        "_typeName": "string",
        "key": "string",
        "arg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "message": "string"
    },
    "actionDescription": {
        "_typeName": "string",
        "key": "string",
        "arg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "message": "string"
    },
    "enabled": false,
    "parameters": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ]
}

string

actionId

Required

The unique action ID

actionLabel

Required

The localized label for the action that is displayed in the UI.

actionDescription

Required

The localized description for the action that is displayed in the UI.

boolean

enabled

Required

True indicates the action will be enabled from UI.

In the data-driven action use case, it is not possible for it to be False.

array of KeyValue

parameters

Optional

The action parameters which can be used as the parameters for this action API when calling from UI.

Property Of

ArrayOfVsanDataDrivenAPIAction