com.iland.core.web.rest.api

Interface DRRunbookResource

All Superinterfaces:

Serializable

@Path(value="/disaster-recovery-runbooks")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface DRRunbookResource
extends Serializable

Recovery Runbook Resource Interface.

Author:

Brett Snyder

Method Summary

Modifier and Type	Method and Description
TaskResponse	abortRunbook(String runbookUuid, DisasterRecoveryRunbookAbortRequest request) Abort a running disaster recovery runbook so that no new operations are initiated upon recovery groups.
void	deleteRunbook(String runbookUuid) Delete a runbook by its UUID.
InputStream	downloadRunbookReport(String runbookUuid, String reportUuid, String filename) Download a PDF summary report for a runbook task.
TaskResponse	executeRunbook(String runbookUuid, DisasterRecoveryRunbookExecuteRequest params) Execute a runbook.
TaskResponse	finalizeExecution(String runbookUuid, DisasterRecoveryRunbookFinalizeExecutionRequest request) Finalize changes for the active runbook execution.
DisasterRecoveryRunbookResponse	getDisasterRecoveryRunbook(String runbookUuid) Gets a runbook by UUID.
DisasterRecoveryRunbookReportDetailsResponse	getRecoveryRunbookReportDetails(String runbookUuid, String taskUuid) Get report summary data for a runbook task.
TaskResponse	testRunbook(String runbookUuid, DisasterRecoveryRunbookTestRequest params) Test a runbook.
DisasterRecoveryRunbookResponse	updateRunbook(String runbookUuid, DisasterRecoveryRunbookUpdateRequest spec) Update a runbook by its UUID.

Method Detail

testRunbook

@POST
 @Path(value="/{runbookUuid}/actions/test")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse testRunbook(@PathParam(value="runbookUuid")
                                                                                                                                                                             String runbookUuid,
                                                                                                                                                                             DisasterRecoveryRunbookTestRequest params)

Test a runbook.

Parameters:

runbookUuid - the UUID of the runbook.

params - the runbook test parameters

Returns:

asynchronous task details

executeRunbook

@POST
 @Path(value="/{runbookUuid}/actions/execute")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse executeRunbook(@PathParam(value="runbookUuid")
                                                                                                                                                                                   String runbookUuid,
                                                                                                                                                                                   DisasterRecoveryRunbookExecuteRequest params)

Execute a runbook.

Parameters:

runbookUuid - the UUID of the runbook.

params - the runbook execution parameters

Returns:

asynchronous task details

getDisasterRecoveryRunbook

@GET
 @Path(value="/{runbookUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DisasterRecoveryRunbookResponse getDisasterRecoveryRunbook(@PathParam(value="runbookUuid")
                                                                                                                                                            String runbookUuid)

Gets a runbook by UUID.

Parameters:

runbookUuid - the UUID of the runbook.

Returns:

the runbook

updateRunbook

@PUT
 @Path(value="/{runbookUuid}")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DisasterRecoveryRunbookResponse updateRunbook(@PathParam(value="runbookUuid")
                                                                                                                                                                                    String runbookUuid,
                                                                                                                                                                                    DisasterRecoveryRunbookUpdateRequest spec)

Update a runbook by its UUID.

Parameters:

runbookUuid - the UUID of the runbook

spec - the specification for updating the runbook

Returns:

the updated runbook

deleteRunbook

@DELETE
 @Path(value="/{runbookUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
void deleteRunbook(@PathParam(value="runbookUuid")
                                                                                                                       String runbookUuid)

Delete a runbook by its UUID.

Parameters:

runbookUuid - the UUID of the runbook

finalizeExecution

@POST
 @Path(value="/{runbookUuid}/actions/finalize")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse finalizeExecution(@PathParam(value="runbookUuid")
                                                                                                                                                  String runbookUuid,
                                                                                                                                                  DisasterRecoveryRunbookFinalizeExecutionRequest request)

Finalize changes for the active runbook execution. The passed params specify whether each recovery group should be rolled back or commited on a per recovery group basis.

Parameters:

runbookUuid - the UUID of the runbook

request - the params for finalizing the runbook execution

Returns:

asynchronous task details

getRecoveryRunbookReportDetails

@GET
 @Path(value="/{runbookUuid}/runbook-task-details/{taskUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
DisasterRecoveryRunbookReportDetailsResponse getRecoveryRunbookReportDetails(@PathParam(value="runbookUuid")
                                                                                                                                                                                                              String runbookUuid,
                                                                                                                                                                                                              @PathParam(value="taskUuid")
                                                                                                                                                                                                              String taskUuid)

Get report summary data for a runbook task.

Parameters:

taskUuid - the uuid of the task to retrieve the report for

Returns:

runbook report details

downloadRunbookReport

@GET
 @Path(value="/{runbookUuid}/reports/{reportUuid}")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+pdf")
InputStream downloadRunbookReport(@PathParam(value="runbookUuid")
                                                                                                                                                       String runbookUuid,
                                                                                                                                                       @PathParam(value="reportUuid")
                                                                                                                                                       String reportUuid,
                                                                                                                                                       @QueryParam(value="filename")
                                                                                                                                                       String filename)

Download a PDF summary report for a runbook task.

The UUID of the task for the runbook operation is the report UUID.

Parameters:

reportUuid - the uuid of the task to retrieve the report for

Returns:

failover report

abortRunbook

@POST
 @Path(value="/{runbookUuid}/actions/abort")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
TaskResponse abortRunbook(@PathParam(value="runbookUuid")
                                                                                                                                          String runbookUuid,
                                                                                                                                          DisasterRecoveryRunbookAbortRequest request)

Abort a running disaster recovery runbook so that no new operations are initiated upon recovery groups.

Parameters:

runbookUuid - the disaster recovery runbook UUID

request - a request for aborting a running recovery runbook operation

Returns:

the aborted task