Snapservice.Clusters.VirtualMachines.Info

Snapservice.Clusters.VirtualMachines.Info

The Snapservice.Clusters.VirtualMachines.Info schema contains properties that provide information regarding a virtual machine.

This schema was added in vSphere API 8.0.3.0.

JSON Example

{
    "name": "string",
    "local_protection_enabled": false,
    "protection_groups": [
        "string"
    ],
    "last_snapshot_time": "string",
    "oldest_snapshot_time": "string",
    "snapshot_count": 0,
    "in_cluster": false,
    "remote_protection_info": {
        "incoming_replication": {
            "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"
                        }
                    ]
                }
            ],
            "license_failure": false,
            "cluster_pair": "string"
        },
        "outgoing_replications": [
            {
                "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"
                            }
                        ]
                    }
                ],
                "license_failure": false,
                "cluster_pair": "string"
            }
        ]
    }
}

string

name

Required

Name of the virtual machine.

This property was added in vSphere API 8.0.3.0.

boolean

local_protection_enabled

Required

Whether or not local protection is enabled. Local protection is considered to be enabled when the virtual machine belongs to at least one active protection group.

This property was added in vSphere API 8.0.3.0.

array of string

protection_groups

Required

List of protection groups that this virtual machine belongs to. Empty list when the virtual machine is not part of any protection group.

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.snapservice.protection_group. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.

string As date-time As date-time

last_snapshot_time

Optional

Time of the last snapshot for the virtual machine.

This property was added in vSphere API 8.0.3.0.

missing or null if there are no snapshots taken for the virtual machine.

string As date-time As date-time

oldest_snapshot_time

Optional

Time of the oldest snapshot for the virtual machine.

This property was added in vSphere API 8.0.3.0.

missing or null if there are no snapshots taken for the virtual machine.

integer As int64 As int64

snapshot_count

Required

Number of snapshots available for the virtual machine.

This property was added in vSphere API 8.0.3.0.

boolean

in_cluster

Required

Indicates whether or not the virtual mahcine is currently part of the cluster. This can be set to false when there is atleast one snapshot for the virtual machine on the target cluster, but the virtual machine is not part of the cluster.

This property was added in vSphere API 8.0.3.0.

remote_protection_info

Optional

Information regarding the remote protection for the virtual machine.

This property was added in vSphere API 9.0.0.0.

missing or null if remote protection is not configured for the virtual machine.