Snapservice.PrecheckResultItem

Snapservice.PrecheckResultItem
Snapservice.PrecheckResultItem

The Snapservice.PrecheckResultItem schema contains properties that provide details about individual precheck validation result.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "type": "string",
    "desc": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi.Std.NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "status": "string",
    "errors": [
        {
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi.Std.NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ]
}
string
type
Required

Identifier of precheck performed. TODO: Add enum with each type

This property was added in vSphere API 9.0.0.0.

desc
Required

Details about the precheck validation.

This property was added in vSphere API 9.0.0.0.

string
status
Required

Status for precheck validation performed.

Possible values:

  • OK: Precheck validation succeeded.
  • WARNING: Precheck validation warning.
  • ERROR: Precheck validation error.

For more information see: Snapservice.PrecheckStatus.

This property was added in vSphere API 9.0.0.0.

errors
Optional

List of localized errors associated with the precheck.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of status is one of Snapservice.PrecheckStatus.WARNING or Snapservice.PrecheckStatus.ERROR.