Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B439 •GetAgentNightlyJobs
•GetJobConfiguration
•GetNightlyJobsSettings
•GetNightlyJobsStatus
•SetAgentJobConfiguration
•SetAgentNightlyJobs
•SetJobConfiguration
•SetNightlyJobsSettings
CancelNightlyJobs
Cancels all nightly jobs execution.
URI: nightlyJobs/
HTTP Method: DELETE
GetAgentJobConfiguration
Gets job configuration for the specified job of the agent.
URI: nightlyJobs/jobConfiguration/{jobId}/{agentId}
HTTP Method: GET
GetAgentNightlyJobs
Gets jobs for the specified agent.
URI: nightlyJobs/config/{agentId}
HTTP Method: GET
GetJobConfiguration
Gets job configuration for the specified job.
URI: nightlyJobs/jobConfiguration/{jobId}
HTTP Method: GET
GetNightlyJobsSettings
Gets nightly jobs settings for the Core.
URI: nightlyJobs/config
HTTP Method: GET
GetNightlyJobsStatus
Determines whether nightly jobs are in progress and then gets the transaction id of currently running jobs.
URI: nightlyJobs/status
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B440
SetAgentJobConfiguration
Sets job configuration for specified agent.
URI: nightlyJobs/jobConfiguration/{jobId}/{agentId}
HTTP Method: PUT
SetAgentNightlyJobs
Sets enabled nightly jobs for the agent.
URI: nightlyJobs/config/{agentId}
HTTP Method: PUT
SetJobConfiguration
Sets job configuration.
URI: nightlyJobs/jobConfiguration/{jobId}
HTTP Method: PUT
SetNightlyJobsSettings
Sets nightly jobs settings for the Core.
URI: nightlyJobs/config
HTTP Method: PUT
IProtectedItemsManagement
This section describes the service operations available for IProtectedItemsManagement at protectedItems/. 
The IProtectedItemsManagement service contract exposes protected items such as agents, clusters, cluster 
nodes and groups as tree.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetProtectedItems
GetProtectedItems
Gets the protected items tree.
URI: protectedItems/allItems
HTTP Method: GET
IPushInstallCommunication
This section describes the service operations available for IPushInstallCommunication at pushinstallcomm/. 
The IPushInstallCommunication service contract is used by Replay internally to communicate between core and 
PushInstall agent. Do not use this API directly.
The URI and HTTP method are provided for each service operation. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B441 The service operations include:
•GetInstallationStatus
•SetInstallationProgress
GetInstallationStatus
Gets installation progress of child push install job.
URI: pushinstallcomm/status/jobs/{jobId}
HTTP Method: GET
SetInstallationProgress
This method is called by push install functionality which is used to track the progress of remote agent 
installation.
URI: pushinstallcomm/setProgress/jobs/{jobId}/{messageType}/{progress}/{message}
HTTP Method: POST
IPushInstallManagement
This section describes the service operations available for IPushInstallManagement at pushinstall/. 
The IPushInstallManagement service contract is the interface implement ability to install agent on remote 
machine. Push install is a functionality that allows user to initiate and control agent installation on remote 
environments in a network.
The URI and HTTP method are provided for each service operation.
The service operations include:
•DeployAgents
•GetAgentServiceState
•GetConfiguration
•GetDeployAgentVersion
•GetInstalledProducts
•IsRemoveAgentProductRequired
•SetConfiguration
•Va l i d a t e M a c h i n e
DeployAgents
Starts deploying agent(s) to remote machines.
URI: pushinstall/deployAgents
HTTP Method: PUT
CAUTION: This method is for internal usage only. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B442
GetAgentServiceState
Checks if agent is already installed on remote machine.
URI: pushinstall/isPushInstallNeed
HTTP Method: POST
GetConfiguration
Gets PushInstall configuration.
URI: pushinstall/config
HTTP Method: GET
GetDeployAgentVersion
Get the version of the Agent to be deployed.
URI: pushinstall/deployAgentVersion
HTTP Method: GET
GetInstalledProducts
Checks for already installed products.
URI: pushinstall/getInstalledProducts
HTTP Method: POST
IsRemoveAgentProductRequired
Checks whether removing of the Agent product is required.
URI: pushinstall/isRemoveAgentProductRequired/{removeProductId}/{installedProductVersion}
HTTP Method: GET
SetConfiguration
Sets PushInstall configuration.
URI: pushinstall/config
HTTP Method: PUT
ValidateMachine
Checks machine availability and permissions for install agent.
URI: pushinstall/validateMachine
HTTP Method: PUT
IRecoveryPointsManagement
This section describes the service operations available for IRecoveryPointsManagement at recoveryPoints/. 
The IRecoveryPointsManagement service contract is the interface implemented by the recovery points 
management service, which exposes information about recovery points to REST clients.
The URI and HTTP method are provided for each service operation. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B443 The service operations include:
•CheckAgentVolumeImages
•CheckAgentVolumeImagesSupport
•DeleteOrphanVolumeImagesChains
•DeleteRecoveryPointsChain
•DeleteRecoveryPointsForAgent
•DeleteRecoveryPointsRange
•DeleteVolumeImages
•DeleteVolumeImagesSupport
•ExportVolumeImagesTree
•GetAgentRecoveryPointCheckSettings
•GetAgentsRecoveryPointsInfo
•GetAllRecoveryPoints
•GetFilteredRecoveryPointsByPage
•GetImageRawData
•GetImageRawKeys
•GetImageRawKeysText
•GetMostRecentRecoveryPoints
•GetRecoveryPointDetails
•GetRecoveryPointLockedKeys
•GetRecoveryPoints
•GetRecoveryPointsByDateRange
•GetRecoveryPointsByPage
•GetRecoveryPointSummary
•GetVolumeImageDetails
•IsOrphanRecoveryPoint
•SetAgentRecoveryPointCheckSettings
CheckAgentVolumeImages
Starts a task that performs integrity check of all agents recovery points and tries to fix errors being found.
URI: recoveryPoints/agents/checkVolumes
HTTP Method: POST
CheckAgentVolumeImagesSupport
Starts a task that performs integrity check of all agents recovery points and tries to fix errors being found. For 
support purpose. Use * symbol as mask for RP and volumes.
URI: 
recoveryPoints/agents/{agentId}/rps/{recoveryPointId}/volumes/{volumeImageId}/integritycheck/target={targ
et}
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B444
DeleteOrphanVolumeImagesChains
Deletes orphan volume images chains for a specified recovery point.
HTTP Method: URI: recoveryPoints/rps/deleteOrphanVolumeImagesChains/{recoveryPointId}
POST
DeleteRecoveryPointsChain
Deletes all volume image chains that contain volume images for a given recovery point.
URI: recoveryPoints/rps/{recoveryPointId}
HTTP Method: DELETE
DeleteRecoveryPointsForAgent
Deletes all recovery points for specified agent.
URI: recoveryPoints/agents/{agentId}
HTTP Method: DELETE
DeleteRecoveryPointsRange
Deletes all recovery points in a specified time period for the specified agent.
URI: recoveryPoints/rps/deleteRecoveryPointsRange
HTTP Method: POST
DeleteVolumeImages
Deletes volume images without rollup for the specified agent. For debug purpose.
URI: recoveryPoints/agents/deleteVolumes
HTTP Method: DELETE
DeleteVolumeImagesSupport
Deletes volume images without rollup for the specified agent.
URI: recoveryPoints/agents/{agentId}/rps/{recoveryPointId}/volumes/{volumeImageId}
HTTP Method: GET
ExportVolumeImagesTree
Exports agent volume images tree to text file.
URI: recoveryPoints/agents/exportVolumeImagesTree
HTTP Method: PUT
GetAgentRecoveryPointCheckSettings
Gets agent recovery point check settings included nightly job and manually started checks.
URI: recoveryPoints/agents/{agentId}/integritycheck/settings
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B445
GetAgentsRecoveryPointsInfo
Gets a list of all agents with recovery points.
URI: recoveryPoints/agents/all
HTTP Method: GET
GetAllRecoveryPoints
Gets the summary information for all recovery points associated with the specified agent. Note that this list can 
potentially be very large.
URI: recoveryPoints/agents/{agentId}/all
HTTP Method: GET
GetFilteredRecoveryPointsByPage
Gets summary info for recovery points for a given agent ID and filter, such that the results are paged for easy 
viewing in a paged grid.
URI: recoveryPoints/agents/{agentId}/paged?max={max}&page={page}
HTTP Method: PUT
GetImageRawData
Gets a stream of data consisting of the data in the image at the specified offset and length. Useful only for 
diagnostic purposes.
URI: recoveryPoints/images/rawdata/{imageId}.rawdata?blockOffset={blockOffset}&blockLength={blockLength}
HTTP Method: GET
GetImageRawKeys
Gets a stream of offset/key pairs, containing the block offsets in the image and the DVM keys of the record at 
each block offset. Useful only for diagnostic purposes.
URI: recoveryPoints/images/rawkeys/{imageId}.rawkeys
HTTP Method: GET
GetImageRawKeysText
Gets a stream of offset/key pairs, containing the block offsets in the image and the DVM keys of the record at 
each block offset. Useful only for diagnostic purposes.
URI: recoveryPoints/images/rawkeys/{imageId}.textkeys
HTTP Method: GET
GetMostRecentRecoveryPoints
Gets summary info for the most recent recovery point of every agent specified in the request.
URI: recoveryPoints/recent
HTTP Method: PUT
GetRecoveryPointDetails
Gets detailed info for a single recovery point.
URI: recoveryPoints/rps/{recoveryPointId}/details
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B446
GetRecoveryPointLockedKeys
Gets a list of encryption keys used by a recovery point that are locked and require a passphrase in order to 
mount.
URI: recoveryPoints/rps/{recoveryPointId}/lockedkeys
HTTP Method: GET
GetRecoveryPoints
Gets the summary information for the recovery points associated with a specified agent that fall outside of a 
last modified date/time range. You also specify a maximum number of recovery points to return with the 
specified range.
URI: recoveryPoints/agents/{agentId}/where?max={max}&olderThan={olderThan}&newerThan={newerThan}
HTTP Method: GET
GetRecoveryPointsByDateRange
Gets the summary information for the recovery points associated with a specified agent that fall inside of a last 
modified date/time range. You also specify a maximum number of recovery points to return with the specified 
range.
URI: recoveryPoints/agents/{agentId}/daterange?max={max}&startDate={startDate}&endDate={endDate}
HTTP Method: GET
GetRecoveryPointsByPage
Gets summary info for recovery points for a given agent ID, such that the results are paged for easy viewing in a 
paged grid.
URI: recoveryPoints/agents/{agentId}/paged?max={max}&page={page}
HTTP Method: GET
GetRecoveryPointSummary
Gets detailed info for a single recovery point.
URI: recoveryPoints/rps/{recoveryPointId}/summary
HTTP Method: GET
GetVolumeImageDetails
Gets information for a single volume image specified by unique identifier.
URI: recoveryPoints/images/{imageId}/
HTTP Method: GET
IsOrphanRecoveryPoint
Gets whether recovery point is orphan or not.
URI: recoveryPoints/rps/{recoveryPointId}/isOrphan
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B447
SetAgentRecoveryPointCheckSettings
Sets agent recovery point check settings included nightly job and manually started checks.
URI: recoveryPoints/agents/{agentId}/integritycheck/settings
HTTP Method: PUT
IRemoteMountManagement
This section describes the service operations available for IRemoteMountManagement at remoteMounts/. 
The IRemoteMountManagement service contract is the Interface implemented by the remote mounts 
management service, used to diconnect mounted volume images on the remote machines.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddRemoteMount
•Disconnect
•DisconnectAll
•DisconnectAllForAgent
•GetAgentRemoteMounts
•GetRemoteMounts
AddRemoteMount
Add information about remote mount point.
URI: remoteMounts/addRemoteMount
HTTP Method: POST
Disconnect
Disconnect remote mount point.
URI: remoteMounts/disconnect/{remoteMountItemId}/mountType/{mountType}
HTTP Method: POST
DisconnectAll
Disconnect all remote mount points.
URI: remoteMounts/disconnectAll
HTTP Method: POST
DisconnectAllForAgent
Disconnect all remote mount points for particular agent.
URI: remoteMounts/disconnectAllForAgent/{agentId}
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B448
GetAgentRemoteMounts
Gets information about remote mount points for particular agent.
URI: remoteMounts/getAgentRemoteMoutns/{agentId}
HTTP Method: POST
GetRemoteMounts
Gets information about remote mount points.
URI: remoteMounts/remoteMountInfos
HTTP Method: POST
IReplayEngineManagement
This section describes the service operations available for IReplayEngineManagement at replayEngine/. 
The IReplayEngineManagement service contract is the interface implemented by the Replay Engine management 
service, used to configure and monitor the Replay Engine.
The URI and HTTP method are provided for each service operation.
The service operations include:
•CloseConnection
•GetConfiguration
•GetConnections
•SetConfiguration
CloseConnection
Forcibly closes an existing connection to the AppAssure Engine.
URI: replayEngine/connections/{id}
HTTP Method: DELETE
GetConfiguration
Retrieves the current configuration of the Replay Engine service.
URI: replayEngine/config
HTTP Method: GET
GetConnections
Gets a list of the active connections to the Replay Engine service.
URI: replayEngine/connections
HTTP Method: GET
SetConfiguration
Sets the configuration of the service.
URI: replayEngine/config
HTTP Method: POST