FailoverParam

FailoverParam
FailoverParam

Input to the failover or testFailover methods.

This structure may be used only with operations rendered under /sms.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "isPlanned": false,
    "checkOnly": false,
    "replicationGroupsToFailover": [
        {
            "_typeName": "string",
            "groupId": {
                "_typeName": "string",
                "faultDomainId": {
                    "_typeName": "string",
                    "id": "string"
                },
                "deviceGroupId": {
                    "_typeName": "string",
                    "id": "string"
                }
            },
            "pitId": {
                "_typeName": "string",
                "id": "string"
            }
        }
    ],
    "policyAssociations": [
        {
            "_typeName": "string",
            "id": {
                "_typeName": "string"
            },
            "policyId": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ]
}
boolean
isPlanned
Required

Whether the failover is a planned failover or not.

Note that testFailover can also be executed in an unplanned mode. When this flag is set to false, the recovery VASA provider must not try to connect to the primary VASA provider during the failover.

boolean
checkOnly
Required

Do not execute the (test) failover but check if the configuration is correct to execute the (test) failover.

If set to true, the (test)failover result is an array where each element is either GroupOperationResult or GroupErrorResult.

If set to false, the (test)failover result is an array where each element is either FailoverSuccessResult or GroupErrorResult.

array of ReplicationGroupData
replicationGroupsToFailover
Optional

The replication groups to failover.

It is OK for the VASA provider to successfully failover only some groups. The groups that did not complete will be retried.

array of PolicyAssociation
policyAssociations
Optional

Storage policies for the devices after (test)failover.

Failover should be done even if policies cannot be associated. Test failover, however, should fail if policies cannot be associated.

If policies cannot be associated, VASA provider can notify the client by doing either or both of these: 1. Set the warning in the result for a replication group to indicate such a failure to set the policy. 2. Raise a compliance alarm after the failover is done.

If not specified, the default policies are used. Callers may reassign policy later.

Property Of
Used By