SettingsClustersSoftwareEntityCheckResult

The Software.EntityCheckResult structure contains fields that describe aggregated status of all checks performed on a specific entity.


Properties

Required Property Name Type Description
required check_statuses array of SettingsClustersSoftwareCheckStatus

List of Software.CheckStatus for all checks performed.

optional cluster string

If the entity type is CLUSTER then the cluster identifier for which the checks have been run. This field is optional and it is only relevant when the value of Software.EntityCheckResult.type is CLUSTER. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

optional host string

If the entity type is HOST then the host identifier for which the checks have been run. This field is optional and it is only relevant when the value of Software.EntityCheckResult.type is HOST. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

required status SettingsClustersSoftwareStatus Enum

Aggregated status from all checks performed on this entity.

required type SettingsClustersSoftwareEntityCheckResultEntityType Enum

The entity type for which these checks are being run.

JSON Example

{
    "check_statuses": [
        {
            "check": {
                "check": "string"
            },
            "status": "enum"
        }
    ],
    "status": "enum",
    "type": "enum"
}
Feedback

Was this page helpful?