FailoverParamsType

Element:

FailoverParams

Type:

FailoverParamsType

Namespace:

http://www.vmware.com/vr/v6.0

Description:

Failover operation parameter.

Since:

1.0

Schema:

hcs-docs.xsd

Media type(s):

application/vnd.vmware.hcs.failoverParams+xml

Extends:

ParamsType

XML Representation:

<FailoverParams xmlns="http://www.vmware.com/vr/v6.0" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="xs:string">
    <vcloud_v1.5:VCloudExtension required="xs:boolean"/>
    <Description> xs:string </Description>
    <PowerOn> xs:boolean </PowerOn>
    <InstanceId> xs:string </InstanceId>
</FailoverParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	1.0		Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	1.0		Optional description.
InstanceId	string	No		2.0
PowerOn	boolean	No		1.0		Flag indicating power On of vApp after Failover is performed. If this flag is not specified vApp will be automatically "powered On" on test/real failover.
VCloudExtension	VCloudExtensionType	No	always	1.0		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /vr/replications/{replicationGroupId}/action/failover	Performs failover for the incoming ReplicationGroup.	1.0