com.iland.core.web.rest.api

Interface VpgResource

@Path(value="/vpgs")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface VpgResource

Vpg Resource interface.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
FailoverTestAlertResponse	addVpgFailoverTestAlert(String vpgUuid, FailoverTestAlertCreateRequest alert) Add a VPG Failover Test Alert for the given VPG.
TaskResponse	commitFailover(String vpgUuid) Commits changes after a live failover.
InputStream	downloadFailoverReport(String vpgUuid, String reportUuid, String filename) Gets a failover report for a task.
TaskResponse	failover(String vpgUuid, FailoverCreateRequest params) Initiates a live failover on the VPG.
TaskResponse	failoverTestForVpg(String vpgUuid, FailoverTestCreateRequest params) Test failover for a VPG.
TaskResponse	failoverTestStop(String vpgUuid, FailoverTestStopCreateRequest params) Stop a VPG failover test and provide feedback as to whether the test was successful.
VpgCheckpointListResponse	getCheckpoints(String vpgUuid) Get checkpoints for a VPG.
FailoverReportDetailsResponse	getFailoverTaskDetails(String vpgUuid, String taskUuid) Gets failover report details for a failover task.
PerformanceCounterListResponse	getPerformanceCountersForVpg(String vpgUuid) Get the list of performance counters that can be used to query for VPG performance data.
PerfSampleSerieResponse	getPerformanceForVpg(String vpgUuid, String group, String name, String type, Long start, Long end) Returns VPG performance samples given a performance serie information.
ServiceProfileResponse	getServiceProfile(String vpgUuid) Gets the service profile for a VPG.
VpgVmListResponse	getVmsForVpg(String vpgUuid) Gets the VMs that belong to a VPG.
ExpandedVpgResponse	getVpg(String vpgUuid, List<VpgSubEntityRequest> expand) Gets a VPG by UUID, with options to expand child entites.
FailoverTestAlertResponse	getVpgFailoverTestAlertFor(String vpgUuid) Retrieve the VPG Failover Test Alert for the given VPG.
void	removeVpgFailoverTestAlert(String vpgUuid) Remove the VPG Failover Test Alert for the given VPG.
TaskResponse	rollbackFailover(String vpgUuid) Rolls back changes after a live failover.

Method Detail

getVpgFailoverTestAlertFor

@GET
 @Path(value="/{vpgUuid}/failover-test-alerts")
FailoverTestAlertResponse getVpgFailoverTestAlertFor(@PathParam(value="vpgUuid")
                                                                                                          String vpgUuid)

Retrieve the VPG Failover Test Alert for the given VPG.

Parameters:

vpgUuid - vpg uuid

Returns:

zerto failover test alert

addVpgFailoverTestAlert

@POST
 @Path(value="/{vpgUuid}/actions/add-failover-test-alert")
 @Consumes(value="application/json")
FailoverTestAlertResponse addVpgFailoverTestAlert(@PathParam(value="vpgUuid")
                                                                                                                                                        String vpgUuid,
                                                                                                                                                        FailoverTestAlertCreateRequest alert)

Add a VPG Failover Test Alert for the given VPG.

Parameters:

vpgUuid - vpg uuid

alert - zerto failover test alert

Returns:

zerto failover test alert

removeVpgFailoverTestAlert

@DELETE
 @Path(value="/{vpgUuid}/actions/remove-failover-test-alert")
void removeVpgFailoverTestAlert(@PathParam(value="vpgUuid")
                                                                                                      String vpgUuid)

Remove the VPG Failover Test Alert for the given VPG.

Parameters:

vpgUuid - vpg uuid

getPerformanceForVpg

@GET
 @Path(value="/{vpgUuid}/performance/{group}::{name}::{type}")
PerfSampleSerieResponse getPerformanceForVpg(@PathParam(value="vpgUuid")
                                                                                                                 String vpgUuid,
                                                                                                                 @PathParam(value="group")
                                                                                                                 String group,
                                                                                                                 @PathParam(value="name")
                                                                                                                 String name,
                                                                                                                 @PathParam(value="type")
                                                                                                                 String type,
                                                                                                                 @QueryParam(value="start")
                                                                                                                 Long start,
                                                                                                                 @QueryParam(value="end")
                                                                                                                 Long end)

Returns VPG performance samples given a performance serie information.

Parameters:

vpgUuid - the VPG unique identifier.

group - performance counter group name

name - performance counter name

type - performance counter type

start - start date

end - end date

Returns:

a performance serie for the vpg, counter and time range

failoverTestForVpg

@POST
 @Path(value="/{vpgUuid}/actions/failover-test")
 @Consumes(value="application/json")
TaskResponse failoverTestForVpg(@PathParam(value="vpgUuid")
                                                                                                                            String vpgUuid,
                                                                                                                            FailoverTestCreateRequest params)

Test failover for a VPG.

Parameters:

vpgUuid - the VPG unique identifier

params - the failover test parameters

Returns:

asynchronous task details

failoverTestStop

@POST
 @Path(value="/{vpgUuid}/actions/failover-test-stop")
 @Consumes(value="application/json")
TaskResponse failoverTestStop(@PathParam(value="vpgUuid")
                                                                                                                               String vpgUuid,
                                                                                                                               FailoverTestStopCreateRequest params)

Stop a VPG failover test and provide feedback as to whether the test was successful.

Parameters:

vpgUuid - the UUID of the VPG.

params - the failover test stop parameters

Returns:

asynchronous task details

getVpg

@GET
 @Path(value="/{vpgUuid}")
ExpandedVpgResponse getVpg(@PathParam(value="vpgUuid")
                                                           String vpgUuid,
                                                           @QueryParam(value="expand")
                                                           List<VpgSubEntityRequest> expand)

Gets a VPG by UUID, with options to expand child entites.

Parameters:

vpgUuid - the UUID of the VPG.

Returns:

the VPG

getVmsForVpg

@GET
 @Path(value="/{vpgUuid}/vms")
VpgVmListResponse getVmsForVpg(@PathParam(value="vpgUuid")
                                                                   String vpgUuid)

Gets the VMs that belong to a VPG.

Parameters:

vpgUuid - the UUID of the VPG

Returns:

the list of VPG VMs

getServiceProfile

@GET
 @Path(value="/{vpgUuid}/service-profile")
ServiceProfileResponse getServiceProfile(@PathParam(value="vpgUuid")
                                                                                         String vpgUuid)

Gets the service profile for a VPG.

Parameters:

vpgUuid - the UUID of the VPG

Returns:

the service profile information for the VPG

failover

@POST
 @Path(value="/{vpgUuid}/actions/failover")
 @Consumes(value="application/json")
TaskResponse failover(@PathParam(value="vpgUuid")
                                                                                                             String vpgUuid,
                                                                                                             FailoverCreateRequest params)

Initiates a live failover on the VPG.

Parameters:

vpgUuid - the UUID of the VPG

params - the failover parameters

Returns:

asynchronous task details

commitFailover

@POST
 @Path(value="/{vpgUuid}/actions/failover-commit")
TaskResponse commitFailover(@PathParam(value="vpgUuid")
                                                                                     String vpgUuid)

Commits changes after a live failover.

Parameters:

vpgUuid - the UUID of the VPG

Returns:

asynchronous task details

rollbackFailover

@POST
 @Path(value="/{vpgUuid}/actions/failover-rollback")
TaskResponse rollbackFailover(@PathParam(value="vpgUuid")
                                                                                         String vpgUuid)

Rolls back changes after a live failover.

Parameters:

vpgUuid - the UUID of the VPG

Returns:

asynchronous task details

getCheckpoints

@GET
 @Path(value="/{vpgUuid}/checkpoints")
VpgCheckpointListResponse getCheckpoints(@PathParam(value="vpgUuid")
                                                                                     String vpgUuid)

Get checkpoints for a VPG.

Parameters:

vpgUuid - the UUID of the VPG

Returns:

list of checkpoints

getFailoverTaskDetails

@GET
 @Path(value="/{vpgUuid}/failover-task-details/{taskUuid}")
FailoverReportDetailsResponse getFailoverTaskDetails(@PathParam(value="vpgUuid")
                                                                                                                      String vpgUuid,
                                                                                                                      @PathParam(value="taskUuid")
                                                                                                                      String taskUuid)

Gets failover report details for a failover task.

Parameters:

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

Returns:

failover report details

downloadFailoverReport

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

Gets a failover report for a task.

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

Parameters:

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

Returns:

failover report

getPerformanceCountersForVpg

@GET
 @Path(value="/{vpgUuid}/performance-counters")
PerformanceCounterListResponse getPerformanceCountersForVpg(@PathParam(value="vpgUuid")
                                                                                                                 String vpgUuid)

Get the list of performance counters that can be used to query for VPG performance data.

Parameters:

vpgUuid - vpg uuid

Returns:

the list of performance counters