Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B469 The service operations include:
•AddExistentByConfigurations
•AddExistentWithIds
•AppendRepositoryFiles
•ApplyDefaultDeduplicationCacheConfiguration
•CheckRepository
•CheckRepositoryIntegrity
•CheckRepositoryIntegrityEstimate
•Create
•DeleteRepository
•GetConfiguration
•GetExistent
•GetFailedDirectories
•GetFreeDiskSpace
•GetRepositories
•GetRepositoriesCacheInfo
•GetRepositoryById
•GetRepositoryCacheInfo
•GetRepositoryFile
•GetRepositorySummaries
•GetRepositoryUsage
•IsRepoErrors
•IsRepositoryMounted
•MoveRepositoryFile
•ReformatRepository
•RenameRepository
•SetConfiguration
•SetRepositoryCacheParameters
•SetRepositoryFileSpecification
•UpdateRepositoriesDirectories
•UpdateRepositorySpecification
•UpdateWriteCachePolicy
•Va l i d a t e D i r e c t o r y Pa t h
•VerifyFileSpecifications
•VerifyNetworkCredentials
•Ve r i f y Pa t h s 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B470
AddExistentByConfigurations
Loads one or several existing repositories.
URI: reposManagement/repositories/addexistentbyconfigurations
HTTP Method: POST
AddExistentWithIds
Load existent repositories by guid list.
URI: reposManagement/repositories/addexistentwithids
HTTP Method: POST
AppendRepositoryFiles
Appends and mounts additional files to a live repository.
URI: reposManagement/repositories/{repositoryId}/append
HTTP Method: POST
ApplyDefaultDeduplicationCacheConfiguration
Create default deduplication cache configuration.
URI: reposManagement/defaults
HTTP Method: PUT
CheckRepository
Checks a repository.
URI: reposManagement/repositories/check
HTTP Method: POST
CheckRepositoryIntegrity
Checks the repository integrity.
URI: reposManagement/repositories/checkRepositoryIntegrity
HTTP Method: POST
CheckRepositoryIntegrityEstimate
Estimates repository check job duration.
URI: reposManagement/repositories/{repositoryId}/checkRepositoryIntegrityEstimate
HTTP Method: GET
Create
Creates a new repository.
URI: reposManagement/repositories
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B471
DeleteRepository
Deletes the specified repository and all data therein.
URI: reposManagement/repositories/{repositoryId}
HTTP Method: DELETE
GetConfiguration
Sets the configuration of the repository service.
URI: reposManagement/config
HTTP Method: GET
GetExistent
Shows the list of the existent repositories described by the configuration file at the specified directory.
URI: reposManagement/repositories/getexistent
HTTP Method: POST
GetFailedDirectories
Gets repositories directories paths that do not pass validation.
URI: reposManagement/repositories/failedDirectories
HTTP Method: GET
GetFreeDiskSpace
Gets the free space in the directory or UNC share.
URI: reposManagement/getFreeDiskSpace
HTTP Method: POST
GetRepositories
Gets a list of all repositories, including configuration and status.
URI: reposManagement/repositories
HTTP Method: GET
GetRepositoriesCacheInfo
Gets all repositories cache info.
URI: reposManagement/repositories/getRepositoriesCacheInfo
HTTP Method: POST
GetRepositoryById
Gets the configuration and status information for a repository.
URI: reposManagement/repositories/{id}/id
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B472
GetRepositoryCacheInfo
Gets the repository cache info.
URI: reposManagement/repositories/{repositoryId}/getRepositoryCacheInfo
HTTP Method: POST
GetRepositoryFile
Gets the configuration and status information for a repository file.
URI: reposManagement/repositories/{repositoryId}/files/{fileId}
HTTP Method: GET
GetRepositorySummaries
Gets a list of all repositories, including configuration and status.
URI: reposManagement/repositorySummaries
HTTP Method: GET
GetRepositoryUsage
Gets the current uses of a specified repository.
URI: reposManagement/repositories/{id}/usage
HTTP Method: GET
IsRepoErrors
Checks if there any repository with errors. Returns true if at least one repository contains error(s).
URI: reposManagement/repositories/isRepoErrors
HTTP Method: GET
IsRepositoryMounted
Verify paths are reachable for a given repository.
URI: reposManagement/repositories/{repositoryId}/isRepositoryMounted
HTTP Method: POST
MoveRepositoryFile
Moves a repository file.
URI: reposManagement/repositories/move
HTTP Method: POST
ReformatRepository
Reformats the repository, deleting any existing recovery points.
URI: reposManagement/repositories/{repositoryId}/format
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B473
RenameRepository
Renames a repository.
URI: reposManagement/repositories/{repositoryId}/{newReposName}/rename
HTTP Method: POST
SetConfiguration
URI: Sets the configuration of the repository service.
reposManagement/config
HTTP Method: POST
SetRepositoryCacheParameters
Updates a repository cache parameters.
URI: reposManagement/repositories/{repositoryId}/setRepositoryCacheParameters
PUT
SetRepositoryFileSpecification
Updates a repository file specification.
URI: reposManagement/repositories/{repositoryId}/file/{repositoryFileId}
PUT
UpdateRepositoriesDirectories
Updates directories for repositories.
URI: reposManagement/repositories/updateDirectories
PUT
UpdateRepositorySpecification
Applies a new specification to a repository.
URI: reposManagement/repositories/updateRepositorySpecification
PUT
UpdateWriteCachePolicy
Updates files write caching policies.
URI: reposManagement/repositories/{repositoryId}/writePolicy
PUT
ValidateDirectoryPath
Perform validation of specified path of the repository directory.
URI: reposManagement/repositories/validateDirectoryPath
POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B474
VerifyFileSpecifications
Verifies paths and free space on the specified devices.
URI: reposManagement/repositories/verifyFileSpecifications
POST
VerifyNetworkCredentials
Verifies network credentials for specified paths.
URI: reposManagement/repositories/verifyNetworkCredentials
POST
Ve r i f y Pa t h s
Verify paths are reachable for a given repository.
URI: reposManagement/repositories/{repositoryId}/verifyPaths
POST
IRollbackManagement
This section describes the service operations available for IRollbackManagement at rollback/. 
The IRollbackManagement service contract is the interface implemented by the core rollback service, which 
provides functionality from the Replay engine to restore data from recovery points.
The URI and HTTP method are provided for each service operation.
The service operations include:
•CheckJobByAgentId
•CheckJobByRrcIp
•GeneratePartitionPlan
•GetDatabasesForRemount
•GetSummaryMetadata
•GetTargetDisks
•GetTargetInfo
•GetTargetVolumes
•StartRollback
•ValidateStoragePoolSettings
•ValidateSystemVolumeExistence
•VerifyRollbackRequest
CheckJobByAgentId
Check state of roll-back job using agent id.
URI: rollback/checkJobByAgentId/{agentId}
HTTP Method: POST
NOTE: The restore functionality was formerly referred to as rollback. This term is deprecated. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B475
CheckJobByRrcIp
Check state of roll-back job using ip address of RRC-agent.
URI: rollback/checkJobByRrcIp/{agentIp}
HTTP Method: POST
GeneratePartitionPlan
Generates a partition plan for a given recovery point, volume list, and target disks.
URI: rollback/autoPartition
HTTP Method: POST
GetDatabasesForRemount
Gets list of databases for remount along with warnings.
URI: rollback/databasesForRemount
HTTP Method: POST
GetSummaryMetadata
Gets the disks which are available on a given rollback (restore) target.
URI: rollback/summarymetadata
HTTP Method: PUT
GetTargetDisks
Gets the disks which are available on a given rollback (restore) target.
URI: rollback/targetDisks
HTTP Method: POST
GetTargetInfo
Gets the disks and volumes which are available on a given rollback (restore) target.
URI: rollback/targetInfo
HTTP Method: POST
GetTargetVolumes
Gets the volumes which are available on a given rollback (restore) target.
URI: rollback/targetVolumes
HTTP Method: POST
StartRollback
Starts a rollback (restore) job.
URI: rollback/target
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B476
ValidateStoragePoolSettings
Validates whether Storage Pool feature was enabled on the protected machine.
URI: rollback/storagepool
HTTP Method: POST
ValidateSystemVolumeExistence
Validate system volume existence.
URI: rollback/validateSystemVolumeExistence
HTTP Method: POST
VerifyRollbackRequest
Verify rollback (restore) request for volumes and disks.
URI: rollback/verifyRollbackRequest
HTTP Method: POST
IRollupManagement
This section describes the service operations available for IRollupManagement at rollup/. 
The IRollupManagement service contract is the interface implemented by the core rollup management service, 
which provides rollup functionality from the Replay engine.
The URI and HTTP method are provided for each service operation.
The service operations include:
•ClearAgentRetentionPolicy
•ForceRollup
•GetAgentRetentionPolicy
•GetCoreRollupConfiguration
•GetGranularityIntervals
•SetAgentRetentionPolicy
•SetCoreRollupConfiguration
ClearAgentRetentionPolicy
Clears an agents retention policy, and instead use the core-wide default one.
URI: rollup/agents/{agentId}
HTTP Method: DELETE
ForceRollup
Force rollup job for agent with given ID.
URI: rollup/agents/{agentId}/force
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B477
GetAgentRetentionPolicy
Gets retention policy for a given agent ID.
URI: rollup/agents/{agentId}
HTTP Method: GET
GetCoreRollupConfiguration
Gets core rollup configuration.
URI: rollup/config
HTTP Method: GET
GetGranularityIntervals
Gets granularity intervals for retention timeline.
URI: rollup/granularityIntervals
HTTP Method: PUT
SetAgentRetentionPolicy
Sets retention policy onto an agent with given ID.
URI: rollup/agents/{agentId}
HTTP Method: PUT
SetCoreRollupConfiguration
Sets core rollup configuration.
URI: rollup/config
HTTP Method: PUT
ISeedDriveManagement
This section describes the service operations available for ISeedDriveManagement at seedDrive/. 
The ISeedDriveManagement service contract is the interface implemented by the seed drive management 
service, which provides copy-consume functionality from the Replay engine.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AbandonOutstandingSeedDrive
•GetConsumedSeedDrives
•GetOutstandingSeedDrives
•GetSeedDriveManifest
•StartConsumeSeedDrive
•StartCopySeedDrive 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B478
AbandonOutstandingSeedDrive
Deletes seed drive from the list of seed drives which are waiting to be consumed.
URI: seedDrive/outstandingSeedDrives/{seedDriveId}
HTTP Method: DELETE
GetConsumedSeedDrives
Gets info about seed drives consumed by specified replicated agent on the slave core.
URI: seedDrive/consumedSeedDrives/{agentId}
HTTP Method: GET
GetOutstandingSeedDrives
Gets outstanding seed drives on master core which are waiting to be consumed on slave cores.
URI: seedDrive/outstandingSeedDrives
HTTP Method: GET
GetSeedDriveManifest
Gets the metadata for an existing seed drive by the core ID.
URI: seedDrive/metadataByCore/{coreId}
HTTP Method: POST
StartConsumeSeedDrive
Starts consuming recovery points data from user-specified seed drive.
URI: seedDrive/consume
HTTP Method: POST
StartCopySeedDrive
Starts copying recovery points data to user-specified seed drive.
URI: seedDrive/copy
HTTP Method: POST
IServiceHostManagement
This section describes the service operations available for IServiceHostManagement at servicehost/. 
The IServiceHostManagement service contract is the interface implemented by a class which provides a 
management interface to the IServiceHost.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetApiVersionInfo
•GetConfiguration
•Restart
•SetConfiguration
•VerifyConnection