Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B449
IReplicationCommunication
This section describes the service operations available for IReplicationCommunication at replicationcomms/. 
The IReplicationCommunication service contract is the used by Replay internally to communicate between cores 
for replication. Do not use this API directly.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddAgentsByDemand
•AddAgentsByRequest
•CancelRemoteMetadataUpdate
•CancelRemoteRollup
•CancelRemoteVolumeImagesDeletion
•CancelUploadFile
•ContinueUploadFile
•DeleteAgent
•DeletePairing
•DemandPairing
•EndCheck
•EndUploadFile
•EndVolumeImageReplicationSession
•EndVolumeImageReplicationSessionOld
•EndVolumeImageVerificationSession
•GetAgentRecoveryPointDetails
•GetAgentRecoveryPoints
•GetAgentRecoveryPointsCount
•GetAgentRepositoryRelationships
•GetAgents
•GetBasicReplicatedVolumeImagesInfo
•GetBasicReplicatedVolumeImagesInfoOld
•GetConsumedSeedDrives
•GetCoreId
•GetExchangeVersions
•GetFileInfoForExchangeDll
•GetMetadataUpdateProgress
•GetNextBlockMD5Digest
•GetNextBlockMD5Digest
•GetPairingStatus
•GetRemoteMasterCoresForDemand
•GetReplicatedAgents
•GetReplicatedAgentsRecoveryPointsInfo 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B450 •GetReplicatedAgentsStorageUsage
•GetRepositories
•GetRepositoryFreeSpaceForAgent
•GetRollupProgress
•GetVolumeImageBlockDigest
•GetVolumeImageBlockIndex
•GetVolumeImageDigest
•GetVolumeImageMD5CheckResult
•GetVolumeImagesDeletionProgress
•NegotiateMissingRecords
•NegotiateMissingRecordsOld
•NewVolumeImageMD5BlockCheck
•RequestPairing
•SelectRangeAgentRecoveryPoints
•StartHashVerificationJob
•StartMetadataUpdate
•StartMetadataUpdate
•StartMetadataUpdateJob
•StartNewUploadSession
•StartNewVolumeImageReplicationSession
•StartRemoteReplicationJob
•StartRollup
•StartRollupJob
•StartTransferJob
•StartVolumeImagesDeletion
•StartVolumeImagesDeletionJob
•StartVolumeImagesDeletionJobOld
•StartVolumeImagesDeletionOld
•StartVolumeImageVerificationSession
•SyncPairingStatus
•SyncRemoteReplicationJob
•TransferMissingRecords
•TransferMissingRecordsOld
•TransferUndiscoveredRecords
•Tr a n s f e r Vo l u m e B l o c k
•UpdateIndex
•UpdateMasterStorageUsage
•UpdateReplicationStatus
•VerifyAddAgentsByDemand
•VerifyAddAgentsByRequest 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B451 •VerifyReplicationAbility
•VerifyReplicationCorePairingAbility
AddAgentsByDemand
Add agents by demand to a remote slave core.
URI: replicationcomms/slave/agents/demand
HTTP Method: POST
AddAgentsByRequest
Add agents by request to a remote slave.
URI: replicationcomms/slave/agents/request
HTTP Method: POST
CancelRemoteMetadataUpdate
Cancels metadata update phase of replication job for replicated agent.
URI: replicationcomms/slave/agents/{agentId}/metadataUpdate
HTTP Method: DELETE
CancelRemoteRollup
Cancels rollup phase of replication job for replicated agent.
URI: replicationcomms/slave/agents/{agentId}/rollup
HTTP Method: DELETE
CancelRemoteVolumeImagesDeletion
Cancels volume images deletion phase of replication job for replicated agent.
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletion
HTTP Method: DELETE
CancelUploadFile
Cancels current upload session.
URI: replicationcomms/slave/sessions/{uploadSessionId}/
HTTP Method: DELETE
ContinueUploadFile
Reads data from slave core in current upload session.
URI: replicationcomms/slave/sessions/{uploadSessionId}/data/{dataSize}
HTTP Method: POST
DeleteAgent
Deletes a replicated agent from the slave core, including all of its recovery points.
URI: replicationcomms/slave/agents/{agentId}
HTTP Method: DELETE 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B452
DeletePairing
Removes replication relationship with Master Core on Slaves Core side. Actual replicated and protected agent 
on Master and Slave Cores stay available.
URI: replicationcomms/slave/pairing?deleteRecoveryPoints={deleteRecoveryPoints}
HTTP Method: DELETE
DemandPairing
Demands the establishment of a pairing relationship with a remote core. Demands are only accepted if the 
caller performs NTLM authentication as a member of the administrators group. This method will reset 
connection for establish new secured connection.
URI: replicationcomms/slave/pairing/demand
HTTP Method: POST
EndCheck
Cancels current MD5 check context.
URI: replicationcomms/slave/contexts/{contextId}/
HTTP Method: POST
EndUploadFile
Ends current upload session and cheks MD5 hash of received file.
URI: replicationcomms/slave/sessions/{uploadSessionId}/
HTTP Method: POST
EndVolumeImageReplicationSession
Ends the volume image replication session, optionally committing the transferred volume image.
URI: replicationcomms/slave/{agentId}/{jobId}/{sessionId}?commit={commit}
HTTP Method: DELETE
EndVolumeImageReplicationSessionOld
Ends the volume image replication session, optionally committing the transferred volume image.
URI: replicationcomms/slave/sessions/{sessionId}?commit={commit}
HTTP Method: DELETE
EndVolumeImageVerificationSession
Ends integrity check session with a slave core.
URI: replicationcomms/slave/check/session/{sessionId}/end?commit={commit}
HTTP Method: DELETE
GetAgentRecoveryPointDetails
Gets the details for a single replicated recovery point.
URI: replicationcomms/slave/agents/{agentId}/rps/{recoveryPointId}
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B453
GetAgentRecoveryPoints
Gets the recovery points replicated for the given agent.
URI: replicationcomms/slave/agents/{agentId}/rps
HTTP Method: GET
GetAgentRecoveryPointsCount
Gets count of the recovery points replicated for the given agent.
URI: replicationcomms/slave/agents/{agentId}/rpsCount
HTTP Method: GET
GetAgentRepositoryRelationships
Gets the repositories for replicated agents.
URI: replicationcomms/slave/cores/agentRepositoryRelationships
HTTP Method: GET
GetAgents
Gets the list of all agents. A pairing must be in place, and this request must be authenticated by the master 
cores client certificate.
URI: replicationcomms/slave/agents
HTTP Method: GET
GetBasicReplicatedVolumeImagesInfo
Gets the details for all recovery points replicated for the given agent.
URI: replicationcomms/slave/agents/{agentId}/replicatedVolumeImagesNew
HTTP Method: GET
GetBasicReplicatedVolumeImagesInfoOld
Gets the details for all recovery points replicated for the given agent.
URI: replicationcomms/slave/agents/{agentId}/replicatedVolumeImages
HTTP Method: GET
GetConsumedSeedDrives
Gets identifiers of seed drives consumed on the Core for specified agent.
URI: replicationcomms/consumedSeedDrives/{agentId}
HTTP Method: GET
GetCoreId
Tests connection to remote core and returns core ID. If useCredentials in true then NTLM authentication used, 
otherwise Anonymous authentication.
URI: replicationcomms/slave/validate/?useCredentials={useCredentials}
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B454
GetExchangeVersions
Gets versions of Exchange dlls, with present on remote slave core.
URI: replicationcomms/slave/exchange
HTTP Method: GET
GetFileInfoForExchangeDll
Gets information for given Exchange DLL file.
URI: replicationcomms/slave/exchange/dllinfo/{fileName}
HTTP Method: POST
GetMetadataUpdateProgress
Gets status of the metadata update job initiated from master core.
URI: replicationcomms/slave/agents/{agentId}/metadataUpdate/status
HTTP Method: GET
GetNextBlockMD5Digest
Get MD5 Digest for specified block.
URI: replicationcomms/slave/getBlockMD5/contextId/{contextId}/count/{blockCount}/md5/{blockMD5}
HTTP Method: POST
GetNextBlockMD5Digest
Gets Volume Image MD5 and size. It does not invoke a new check.
URI: replicationcomms/slave/getVolumeImageMD5/?volumeId={volumeId}
HTTP Method: GET
GetPairingStatus
Gets the status of the pairing between the calling core and the remote slave core. The caller is identified by its 
SSL client certificate. This method is available to a remote core regardless of whether it was paired by way of a 
request or the initiation of the pairing itself.
URI: replicationcomms/slave/pairing/status
HTTP Method: GET
GetRemoteMasterCoresForDemand
Getting remote masers cores info for current slave core. Using NTLM authentication.
URI: replicationcomms/slave/cores/masters
HTTP Method: GET
GetReplicatedAgents
Gets the list of agents the caller is replicating to this slave core. A pairing must be in place, and this request 
must be authenticated by the master cores client certificate.
URI: replicationcomms/slave/agents
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B455
GetReplicatedAgentsRecoveryPointsInfo
Gets the list of agents which have recovery points on a remote slave core.
URI: replicationcomms/slave/agents/rpsinfo
HTTP Method: GET
GetReplicatedAgentsStorageUsage
Gets a summary of storage usage of the replicated agents.
replicationcomms/slave/agents
HTTP Method: GET
GetRepositories
Gets all repositories. With certificate authentication for already paired cores.
URI: replicationcomms/slave/repositories
HTTP Method: GET
GetRepositoryFreeSpaceForAgent
Get free space for agents remote repository.
URI: replicationcomms/slave/agents/{agentId}
HTTP Method: GET
GetRollupProgress
Gets status of the rollup job initiated from master core.
replicationcomms/slave/agents/{agentId}/rollup/progress
HTTP Method: GET
GetVolumeImageBlockDigest
Get volume image block digest for specified block.
URI: replicationcomms/slave/check/session/{sessionId}/blockDigest
HTTP Method: POST
GetVolumeImageBlockIndex
Get volume image index values for specified block.
URI: replicationcomms/slave/check/session/{sessionId}/index?block={blockNumber}
HTTP Method: GET
GetVolumeImageDigest
Gets volume image digest for a specified integrity check session.
URI: replicationcomms/slave/check/session/{sessionId}/digest
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B456
GetVolumeImageMD5CheckResult
Gets current volume MD5 check result for the context.
URI: replicationcomms/slave/checkResult/{contextId}/
HTTP Method: POST
GetVolumeImagesDeletionProgress
Gets status of the deletion job initiated from master core
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletion/progress
HTTP Method: GET
NegotiateMissingRecords
Sends a stream of record metadata for the image being replicated, and receives back a stream of records which 
are missing from the remote core.
URI: replicationcomms/slave/{agentId}/{jobId}/{sessionId}/records/keys
HTTP Method: POST
NegotiateMissingRecordsOld
Sends a stream of record metadata for the image being replicated, and receives back a stream of records which 
are missing from the remote core.
URI: replicationcomms/slave/sessions/{sessionId}/records/keys
HTTP Method: POST
NewVolumeImageMD5BlockCheck
Starts new MD5 check and master/slave volume record index compare session. Returns contextId.
URI: replicationcomms/slave/volumeImageMD5BlockCheck/{volumeId}
HTTP Method: POST
RequestPairing
Sends a request to a remote slave for authorization to replicate one or more agents. The request is adjudicated 
by a human operator and will be approved or denied at a later date. This method will reset connection for 
establish new secured connection.
URI: replicationcomms/slave/pairing/request
HTTP Method: POST
SelectRangeAgentRecoveryPoints
Select range of the recovery points replicated for the given agent.
URI: replicationcomms/slave/agents/{agentId}/skipCount/{skipCount}/maxCount/{maxCount}/rps
HTTP Method: GET
StartHashVerificationJob
Starts integrity check job for specified agent.
URI: replicationcomms/slave/agents/{agentId}/verification/{jobId}/start
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B457
StartMetadataUpdate
Starts metadata update for specified agent.
URI: replicationcomms/slave/agents/{agentId}/metadataUpdate
HTTP Method: POST
StartMetadataUpdateJob
Starts metadata update job for specified agent.
URI: replicationcomms/slave/agents/{agentId}/metadataUpdateJob
HTTP Method: POST
StartNewUploadSession
Starts new file upload session.
URI: replicationcomms/slave/newsession/
HTTP Method: POST
StartNewVolumeImageReplicationSession
Starts a replication session with a slave core.
URI: replicationcomms/slave/sessions/new
HTTP Method: POST
StartRemoteReplicationJob
Starts remote mirrored replication job on slave core.
URI: replicationcomms/slave/agents/replicationJob/start
HTTP Method: POST
StartRollup
Starts rollup for specified slave agent for specified granularity cells (time intervals).
URI: replicationcomms/slave/agents/{agentId}/rollup
HTTP Method: POST
StartRollupJob
Starts rollup job for specified slave agent for specified granularity cells (time intervals).
URI: replicationcomms/slave/agents/{agentId}/rollupJob
HTTP Method: POST
StartTransferJob
Starts remote mirrored transfer job on slave core.
URI: replicationcomms/slave/agents/{agentId}/transferJob/{jobId}
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B458
StartVolumeImagesDeletion
Starts deletion of volume images with specified identifiers for specified agent.
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletionNew
HTTP Method: POST
StartVolumeImagesDeletionJob
Starts deletion of volume images job with specified identifiers for specified agent.
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletionJobNew
HTTP Method: POST
StartVolumeImagesDeletionJobOld
Starts deletion of volume images job with specified identifiers for specified agent.
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletionJob
HTTP Method: POST
StartVolumeImagesDeletionOld
Starts deletion of volume images with specified identifiers for specified agent.
URI: replicationcomms/slave/agents/{agentId}/volumeImagesDeletion
HTTP Method: POST
StartVolumeImageVerificationSession
Starts a integrity check session with a slave core.
URI: replicationcomms/slave/check/{agentId}/{jobId}/session/start
HTTP Method: POST
SyncPairingStatus
Gets the status of the pairing between the calling core and the remote slave core. The caller is identified by its 
SSL client certificate. This method is available to a remote core regardless of whether it was paired by way of a 
request or initiation of the pairing itself.
URI: replicationcomms/slave/pairing/sync
HTTP Method: POST
SyncRemoteReplicationJob
Sync with remote mirrored replication job on slave core.
URI: replicationcomms/slave/agents/replicationJob/sync
HTTP Method: POST
TransferMissingRecords
Sends a stream of raw records to the slave core, the list of which is determined by NegotiateMissingRecords.
URI: replicationcomms/slave/{agentId}/{jobId}/{sessionId}/records/rawdata
HTTP Method: POST