Precheck

Precheck
Precheck

Represents the comprehensive outcome of a single precheck execution, including its details, status, and any identified issues.

JSON Example
{
    "resourceId": "resourceId",
    "issue": {
        "id": "VCF-ERROR-001",
        "type": "WARN",
        "message": {
            "args": {
                "cloudProxyFqdn": "cloudProxy1.vsphere.local"
            },
            "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
            "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
            "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
        },
        "resolution": {
            "args": {
                "cloudProxyFqdn": "cloudProxy1.vsphere.local"
            },
            "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
            "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
            "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
        }
    },
    "name": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "resourceName": "resourceName",
    "startTime": "2000-01-23T04:56:07.000Z",
    "id": "SYSTEM_HEALTH_CHECK",
    "endTime": "2000-01-23T04:56:07.000Z",
    "status": null
}
string
id
Required

A unique, human-readable identifier representing the type or category of this specific precheck. This ID allows for consistent identification of the precheck being run across different executions. Examples: 'SYSTEM_HEALTH_CHECK', 'APUAT_CHECK', 'RESOURCE_ALLOCATION_CHECK'.

string
resourceId
Optional

An identifier for the specific resource against which this precheck was run.

string
resourceName
Optional

Name of the resource on which precheck was run

LocalizableMessage
name
Required

name

PrecheckStatus
status
Required

Defines possible task step states

Possible values are : PENDING, RUNNING, SUCCEEDED, FAILED, SKIPPED,
PrecheckIssue
issue
Optional

Represents a single problem, either a warning or an error, found during a precheck.

string As date-time As date-time
startTime
Required

The timestamp (ISO 8601 format) when this precheck execution started.

string As date-time As date-time
endTime
Required

The timestamp (ISO 8601 format) when this precheck execution completed.

Property Of