This is an archive version of the document. To get the most up-to-date information, see the current version.Run Failover
|
To run a failover plan, it must be ENABLED. For more information on states that a failover plan can acquire, see the Veeam Availability Orchestrator User Guide, section Running and Scheduling Failover Plans. |
You can run a failover plan with the specified ID.
Request
To fail over VMs in a plan to their replicas, send the HTTP POST request to the URL of the /FailoverPlans/{id}/Run resource.
HTTP Request
POST https://<hostname>:<port>/v2/FailoverPlans/{id}/Run |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Content-Type | required | application/json | Identifies a media type that is used in the body of the request. |
Accept | optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
In the request body, you must send the mode parameter with the "FailoverNow" value.
To start plan execution in this mode, you must also use action-specific parameters. For more information on the parameters, see section Plan Launch Options.
{ "mode": "FailoverNow", "planlaunchOptions": { "restorePointRule": { "date": "<Date>" }, "executeChainedPlans": true/false } } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 Success.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Example
The following example runs a failover plan with the ID b8517d70-028d-4740-a130-787e164a3d83.
|
