Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B399
IApplianceEventsManagement
This section describes the service operations available for IApplianceEventsManagement at events/appliance/. 
The IApplianceEventsManagement service contract exposes the appliance events for the Core.
The URI and HTTP method is provided for the service operation:
•SendApplianceEvent
SendApplianceEvent
Posts the passed in event.
URI: events/appliance/raise
HTTP Method: POST
IApplicationIdManagement
This section describes the service operations available for IApplicationIdManagement at id/. The 
IApplicationIdManagement service contract exposes the applications unique ID.
The URI and HTTP method is provided for the service operation:
•SendApplianceEvent
GetId
Gets the ID for the Core.
URI: id/
HTTP Method: GET
IAutoUpdateManagement
This section describes the service operations available for IAutoUpdateManagement at autoupdate/. 
The URI and HTTP method are provided for each service operation.
The service operations include:
•CheckUpdates
•ForceUpgrade
•GetConfiguration
•GetState
•IsCoreServiceStarting
•SetConfiguration
CheckUpdates
Checks for updates.
URI: autoupdate/checkForUpdates
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B400
ForceUpgra de
Sets AutoUpdate configuration.
URI: autoupdate/forceUpgrade
HTTP Method: POST
GetConfiguration
Sets AutoUpdate configuration.
URI: autoupdate/config
HTTP Method: GET
GetState
Runs an upgrade.
URI: autoupdate/updateState
HTTP Method: GET
IsCoreServiceStarting
Returns a value of ‘True’ if determined that the Core service has restarted.
URI: autoupdate/isCoreServiceRestarting
HTTP Method: GET
SetConfiguration
Gets current update status.
URI: autoupdate/config
HTTP Method: PUT
IBackgroundJobManagement
This section describes the service operations available for IBackgroundJobManagement at jobmgr/. 
The IBackgroundJobManagement service contract is the WCF contract interface implemented by a class which 
implements the management interface on top of the background job manager.
The URI and HTTP method are provided for each service operation.
The service operations include:
•CancelChildJob
•CancelJob
•GetBackgroundJobsConfiguration
•GetJob
•GetJobs
•GetJobsByPage
•GetJobsCount
•ResetBackgroundJobSettings
•UpdateBackgroundJobSettings 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B401
CancelChildJob
Cancels the child job.
URI: jobmgr/jobs/{parentJobId}/childJobs/{childJobId}
HTTP Method: DELETE
CancelJob
Cancels the job.
URI: jobmgr/jobs/{jobId}
HTTP Method: DELETE
GetBackgroundJobsConfiguration
Gets background jobs configuration.
URI: jobmgr/config
HTTP Method: GET
GetJob
Gets the specified job.
URI: jobmgr/jobs/{jobId}
HTTP Method: GET
GetJobs
Gets all jobs that pass through the specified filter in both the memory and the database.
URI: jobmgr/jobs/all
HTTP Method: PUT
GetJobsByPage
Gets the current list of jobs that pass through the specified filter which are then presented for ease of viewing 
by a paged grid.
URI: jobmgr/jobs/paged/{jobsPerPage}/{page}
HTTP Method: PUT
GetJobsCount
Gets the current number of jobs that pass through the specified filter in both the memory and the database.
URI: jobmgr/jobs/count
HTTP Method: PUT
ResetBackgroundJobSettings
Resets the background job setting to the default setting.
URI: jobmgr/resetSettings
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B402
UpdateBackgroundJobSettings
Performs an update of the background job settings.
URI: jobmgr/settings
HTTP Method: PUT
IBackupManagement
This section describes the service operations available for IBackupManagement at backup/. 
The IBackupManagement service contract is the Interface implemented by the core backup management 
service, used for backing up and restoring a local core.
The URI and HTTP method are provided for each service operation.
The service operations include:
•DeleteScheduledBackup
•GetBackupAgentRecoveryPointsInfo
•GetBackupAgentRecoveryPointsInfoByCore
•GetBackupManifest
•GetBackupManifests
•GetScheduledBackups
•GetWaitingJobs
•PauseScheduledBackup
•ResumeScheduledBackup
•SaveScheduledBackupSettings
•StartBackup
•StartCheckBackup
•StartRestore
•UpdateBackup
•UpdateRestore
•VerifyBackupLocation
•VerifyRestoreContent
•VerifyRestoreLocation
DeleteScheduledBackup
Deletes scheduled archives.
URI: backup/deleteScheduledBackups
HTTP Method: DELETE
GetBackupAgentRecoveryPointsInfo
Gets the metadata for an existing agent backup by agentId.
URI: backup/metadataByCore/agents/{agentId}
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B403
GetBackupAgentRecoveryPointsInfoByCore
Gets the metadata for an existing agent backup by agentId and coreId.
URI: backup/metadataByCore/{requestedCoreId}/agents/{agentId}
HTTP Method: POST
GetBackupManifest
Gets the metadata for an existing core backup by coreId.
URI: backup/metadataByCore/{requestedCoreId}
HTTP Method: POST
GetBackupManifests
Gets all of the metadata for an existing backup.
URI: backup/metadataAll
HTTP Method: POST
GetScheduledBackups
Retrieves settings for all scheduled backups.
URI: backup/scheduledBackups
HTTP Method: GET
GetWaitingJobs
Gets a list of waiting backup and restore jobs.
URI: backup/waiting
HTTP Method: GET
PauseScheduledBackup
Pauses scheduled archives.
URI: backup/pauseScheduledBackups
HTTP Method: POST
ResumeScheduledBackup
Resumes scheduled archives.
URI: backup/resumeScheduledBackups
HTTP Method: POST
SaveScheduledBackupSettings
Saves scheduled archive.
URI: backup/saveScheduledBackupSettings
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B404
StartBackup
Starts a backup.
URI: backup/backup
HTTP Method: POST
StartCheckBackup
Starts a backups check.
URI: backup/checkBackup
HTTP Method: POST
StartRestore
Starts a restore.
URI: backup/restore
HTTP Method: POST
UpdateBackup
Updates the job request for an existing backup.
URI: backup/backup/update/{jobId}
HTTP Method: POST
UpdateRestore
Updates the job request for an existing restore.
URI: backup/restore/update/{jobId}
HTTP Method: POST
VerifyBackupLocation
Verifies whether the correct file system path is specified as backup location and that the backup can be placed 
at this path.
URI: backup/verifyBackupLocation
HTTP Method: POST
VerifyRestoreContent
Verifies whether backup content is not in conflict state with currently protected machines.
URI: backup/verifyRestoreContent
HTTP Method: POST
VerifyRestoreLocation
Verifies whether backup job has been completed for specified location and core.
URI: backup/verifyCanStartRestore
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B405
IBootCdBuilderManagement
This section describes the service operations available for IBootCdBuilderManagement at bootcdbuilder/. 
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetDefaultOutputPath
•StartBuildingIso
•ValidateDriverPackages
•VerifyBuildingIsoParameters
GetDefaultOutputPath
Gets the default path were resulting ISO image will be put if output path was not specified explicitly.
URI: bootcdbuilder/defaults
HTTP Method: GET
StartBuildingIso
Starts new ISO image building task.
URI: bootcdbuilder/start
HTTP Method: POST
ValidateDriverPackages
Performs validation of specified driver packages.
URI: bootcdbuilder/validate
HTTP Method: POST
VerifyBuildingIsoParameters
Verifies that ISO parameters are built properly.
URI: bootcdbuilder/verify
HTTP Method: POST
ICloudManagement
This section describes the service operations available for ICloudManagement at cloud/. The ICloudManagement 
service contract exposes the Cloud management API.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddConfigurationAccount
•DeleteConfigurationAccount
•GetCloudConfiguration
•GetConfigurationAccount
•IsConfigurationAccountUsed 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B406 •ListFiles
•ListFolders
•ListItems
•SetCloudConfiguration
•StartDownload
•StartUpload
•UpdateConfigurationAccount
•VerifyConnect
AddConfigurationAccount
Add account to cloud configuration.
URI: cloud/configurationAccount
HTTP Method: POST
DeleteConfigurationAccount
Delete existing account of cloud configuration.
URI: cloud/configurationAccount/{accountId}
HTTP Method: DELETE
GetCloudConfiguration
Gets cloud configuration.
URI: cloud/config
HTTP Method: GET
GetConfigurationAccount
Get existing account of cloud configuration.
URI: cloud/configurationAccount/{accountId}
HTTP Method: GET
IsConfigurationAccountUsed
Checks whether cloud account is used, for example, scheduled archive.
URI: cloud/isConfigurationAccountUsed/{accountId}
HTTP Method: GET
ListContainers
Gets cloud containers.
URI: cloud/containers?accountId={0}
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B407
ListFiles
Gets cloud files.
URI: cloud/items
HTTP Method: PUT
ListFolders
Gets cloud folders.
URI: cloud/items
HTTP Method: PUT
ListItems
Gets cloud files and folders.
URI: cloud/items
HTTP Method: PUT
SetCloudConfiguration
Sets cloud configuration.
URI: cloud/config
HTTP Method: PUT
StartDownload
Starts a download.
URI: cloud/download
HTTP Method: PUT
StartUpload
Starts an upload.
URI: cloud/upload
HTTP Method: PUT
UpdateConfigurationAccount
Edit existing account of cloud configuration.
URI: cloud/configurationAccount
HTTP Method: PUT
Ve r i f y C o n n e c t
Verify cloud availability.
URI: cloud/verifyConnect
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B408
IClustersManagement
This section describes the service operations available for IClustersManagement at clusters/. The 
IClustersManagement service contract exposes the Cluster management API.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddClusterAgent
•AddClusterNodeAgent
•ConvertAgentToClusterNode
•ConvertClusterNodeToAgent
•GetClusterNodes
•GetRecommendedClusterRepositoryIds
•GetReplicatedClusterNodes
AddClusterAgent
Add cluster node to existing cluster.
URI: clusters/new
HTTP Method: PUT
AddClusterNodeAgent
Add cluster node to existing cluster.
URI: clusters/{clusterId}/nodes/new
HTTP Method: POST
ConvertAgentToClusterNode
Convert regular agent to cluster node.
URI: clusters/{agentId}/convertToNode
HTTP Method: POST
ConvertClusterNodeToAgent
Convert cluster node to regular agent.
URI: clusters/{clusterNodeId}/convertToAgent
HTTP Method: POST
GetClusterNodes
Gets a list of cluster nodes for specified cluster agent.
URI: clusters/clusterNodes/{clusterAgentId}
HTTP Method: GET