Vcenter NamespaceManagement Supervisors Recovery Backup Archives Info

Vcenter NamespaceManagement Supervisors Recovery Backup Archives Info

The Vcenter NamespaceManagement Supervisors Recovery Backup Archives Info contains information about a Supervisor Backup archive.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "archive": "string",
    "supervisor": "string",
    "location": "string",
    "timestamp": "string",
    "supervisor_version": "string",
    "namespaces": [
        "string"
    ],
    "comment": "string",
    "usable": false,
    "unusable_reasons": [
        {
            "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

archive

Required

Backup archive identifier.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.backup.Archive. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.backup.Archive.

string

supervisor

Required

Identifier of the Supervisor captured in the backup.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

string

location

Required

Absolute path to Backup archive on vCenter Server Appliance file system.

This property was added in vSphere API 8.0.3.0.

string As date-time As date-time

timestamp

Required

Time when the Supervisor backup operation was completed.

This property was added in vSphere API 8.0.3.0.

string

supervisor_version

Required

Version of the Supervisor captured in the backup. This is a semantic version string in the form v1.26.1+vmware.2-vsc0.1.1-20805373, where the prefix is the Kubernetes version (v1.26.1) and the suffix is the Supervisor build version (vsc0.1.1-20805373).

This property was added in vSphere API 8.0.3.0.

array of string

namespaces

Required

A list of Supervisor Namespaces captured in the backup.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance.

string

comment

Required

Comment provided when invoking POST /vcenter/namespace-management/supervisors/{supervisor}/recovery/backup/jobs operation.

This property was added in vSphere API 8.0.3.0.

boolean

usable

Required

Backup archive usability for POST /vcenter/namespace-management/supervisors/{supervisor}/recovery/restore/jobs/{archive} operation. It is set to false in following cases:

• The supervisor is not found.
• Backup was taken on a newer vCenter Server. i.e. Supervisor build version component of the supervisor_version value is more recent than Supervisor build version component of supervisor Vcenter NamespaceManagement Software Clusters Info.current_version and all of the Vcenter NamespaceManagement Software Clusters Info.available_versions.
• Kubernetes version component of the supervisor_version value is not a supported on the current vCenter Server version. Refer "VMware vSphere with Tanzu" Release notes for Kubernetes versions supported on a vCenter Server version.
• Invalid format. If false, the list of reasons that make it unusable will be given in the unusable_reasons field.

This property was added in vSphere API 8.0.3.0.

array of Vapi Std LocalizableMessage

unusable_reasons

Required

Reasons that make Bacup archive unusable. Will be empty if usable value is true.

This property was added in vSphere API 8.0.3.0.