Snapservice.Clusters.VirtualMachines.ReplicationInfo

Snapservice.Clusters.VirtualMachines.ReplicationInfo
Snapservice.Clusters.VirtualMachines.ReplicationInfo

The Snapservice.Clusters.VirtualMachines.ReplicationInfo schema contains properties that provide information regarding the replication configuration for a virtual machine.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "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
status
Required

Replication state for the virtual machine.

Possible values:

  • ERROR: The group has replication or configuration errors
  • MOVING: The group is in the process of being moved to a different HBR server
  • CONFIGURING: The group is in the process of being configured or re-configured
  • PAUSED: The replication for this group is being paused
  • FULL_SYNC: Full sync is performed on this group
  • INITIAL_FULL_SYNC: Initial full sync is performed, this state happens only once in a group's lifetime
  • SYNC: There is live replication traffic for this group
  • NOT_ACTIVE: There is no replication trafic for this group and there are no opened connecitons for it.
  • OK: The group is configured properly, no configuration or replication errors are present. But no actual replication traffic is taking place at the moment.
  • UNKNOWN: The group's status cannot be determined.
  • RECOVERING: A recovery is being performed on this group.
  • RECOVERED: The replication group has been successfully recovered.
  • DISK_RESIZING: Some of the target disks are currently resizing

For more information see: Snapservice.Clusters.VirtualMachines.ReplicationStatus.

This property was added in vSphere API 9.0.0.0.

errors
Optional

List of replication configuration errors for the virtual machine. If missing or null no failure reason is available for the virtual machine.

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 Snapservice.Clusters.VirtualMachines.ReplicationStatus.ERROR.

boolean
license_failure
Optional

Virtual machine replication configuration failed due to invalid license.

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 Snapservice.Clusters.VirtualMachines.ReplicationStatus.ERROR.

string
cluster_pair
Required

Cluster pair for which the virtual machine replication is configured.

This property was added in vSphere API 9.0.0.0.

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