NamespaceManagement_Supervisors_Recovery_Backup_Archives_Info

NamespaceManagement_Supervisors_Recovery_Backup_Archives_Info
NamespaceManagement_Supervisors_Recovery_Backup_Archives_Info

The Archives.Info contains information about a Supervisor Backup archive.

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": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ]
}
string
archive
Required

Backup archive identifier. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.backup.Archive. When operations return a value of this structure as a result, the field 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. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor. When operations return a value of this structure as a result, the field 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.

string As date-time
timestamp
Required

Time when the Supervisor backup operation was completed.

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).

array of string
namespaces
Required

A list of Supervisor Namespaces captured in the backup. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.namespaces.Instance.

string
comment
Required

Comment provided when invoking Jobs.create operation.

boolean
usable
Required

Backup archive usability for Jobs.create operation. It is set to false in following cases:

  • The Archives.Info.supervisor is not found.
  • Backup was taken on a newer vCenter Server. i.e. Supervisor build version component of the Archives.Info.supervisor-version value is more recent than Supervisor build version component of Archives.Info.supervisor Clusters.Info.current-version and all of the Clusters.Info.available-versions.
  • Kubernetes version component of the Archives.Info.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 Archives.Info.unusable-reasons field.
array of Std_LocalizableMessage
unusable_reasons
Required

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