This is an archive version of the document. To get the most up-to-date information, see the current version.

/cloud/cloudFailoverPlans/{ID}

Represents a cloud failover plan that has the specified ID.

Resource URL

The URL of the reference resource representation:

http://<Enterprise-Manager>:9399/api/cloud/cloudFailoverPlans/{ID}

The URL of the entity resource representation:

http://<Enterprise-Manager>:9399/api/cloud/cloudFailoverPlans/{ID}?format=Entity

Related Resources

Methods

The following methods are supported for the /cloud/cloudFailoverPlans/{ID} resource:

Resource Representation

The /cloud/cloudFailoverPlans/{ID} resource has a resource representation of the following types.

Entity reference resource representation:

Entity resource representation:

<CloudFailoverPlan xmlns="http://www.veeam.com/ent/v1.0" Type="CloudFailoverPlan" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf?format=Entity" Name="ABC Company Failover Plan" UID="urn:veeam:CloudFailoverPlan:e7ca6822-a87f-443d-8aae-8005970543bf">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/8fff3b8e-c3f1-4ef5-aecc-561f07bf9982" Name="172.17.53.48" />
<Link Rel="Alternate" Type="CloudFailoverPlanReference" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf" Name="ABC Company Failover Plan" />
<Link Rel="Edit" Type="CloudFailoverPlanReference" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf" Name="ABC Company Failover Plan" />
<Link Rel="Start" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf?action=start" />
<Link Rel="Undo" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf?action=undo" />
<Link Rel="Delete" Type="CloudFailoverPlanReference" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf" Name="ABC Company Failover Plan" />
</Links>
<TenantUid>urn:veeam:CloudTenant:b25f5f1d-a3c3-45ed-af23-9ef31a94dac7</TenantUid>
<TenantName>ABC Company</TenantName>
<Description>Cloud failover plan for ABC Company full site failover</Description>
<CloudFailoverPlanOptions>
<PostFailoverPlanCommandEnabled>false</PostFailoverPlanCommandEnabled>
<PostFailoverPlanCommand />
<PreFailoverPlanCommandEnabled>false</PreFailoverPlanCommandEnabled>
<PreFailoverPlanCommand />
</CloudFailoverPlanOptions>
<CloudFailoverPlanInfo>
<Includes>
<CloudFailoverPlanVm Type="CloudFailoveredVm" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf/includes/231a6e3e-09e6-4641-9322-40898fcb966a">
<FailoverPlanVMId>231a6e3e-09e6-4641-9322-40898fcb966a</FailoverPlanVMId>
<Name>srv38</Name>
<Order>0</Order>
</CloudFailoverPlanVm>
<CloudFailoverPlanVm Type="CloudFailoveredVm" Href="http://localhost:9399/api/cloud/cloudFailoverPlans/e7ca6822-a87f-443d-8aae-8005970543bf/includes/096a7d0a-c92a-4da4-9302-4416b2fe929f">
<FailoverPlanVMId>096a7d0a-c92a-4da4-9302-4416b2fe929f</FailoverPlanVMId>
<Name>srv40</Name>
<Order>1</Order>
</CloudFailoverPlanVm>
</Includes>
</CloudFailoverPlanInfo>
</CloudFailoverPlan>