Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B409
GetRecommendedClusterRepositoryIds
Gets a list of repository ids that are recommended to be used for cluster nodes.
URI: clusters/recommendedRepositories/{clusterAgentId}
HTTP Method: GET
GetReplicatedClusterNodes
Gets a list of replicated cluster nodes for specified cluster agent.
URI: clusters/replicatedClusterNodes/{clusterAgentId}
HTTP Method: GET
ICoreBackupRestoreManagement
This section describes the service operations available for ICoreBackupRestoreManagement at 
corebackuprestore/. 
The ICoreBackupRestoreManagement service contract is the interface implemented by core configuration 
backup/restore management service used to perform backup and restore of core configuration.
The URI and HTTP method are provided for each service operation.
The service operations include:
•BackupCoreConfiguration
•ReadRepositoriesFromBackupSettings
•RestoreCoreConfiguration
•RestoreCoreConfigurationWithRestart
•ValidateRepositoryDirectory
BackupCoreConfiguration
Performs backup of Core configuration.
URI: corebackuprestore/backup
HTTP Method: POST
ReadRepositoriesFromBackupSettings
Performs validation of repositories paths in backup configuration file. Returns dictionary.
URI: corebackuprestore/validatexml
HTTP Method: POST
RestoreCoreConfiguration
Performs restore of Core configuration.
URI: corebackuprestore/restore
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B410
RestoreCoreConfigurationWithRestart
Performs restore of Core configuration. Core service will be restarted for apply new configurations.
URI: corebackuprestore/restoreWithRestart
HTTP Method: POST
ValidateRepositoryDirectory
Performs validation of repository directory path. Once the path is verified, a value of ‘True’ is returned.
URI: corebackuprestore/validatedirectory
HTTP Method: POST
ICoreCallbackManagement
This section describes the service operations available for ICoreCallbackManagement at corecallback/. 
The ICoreCallbackManagement service contract is the interface implemented by the core callback management 
service, used to be called by remote agent.
The URI and HTTP method are provided for each service operation.
The service operations include:
•ProcessAgentProtectionRequest
•VerifyConnect
ProcessAgentProtectionRequest
The method is called by failover agent in order to perform remote pairing. This method is for internal usage 
only.
URI: corecallback/agentprotectionrequest
HTTP Method: POST
Ve r i f y C o n n e c t
Called by agent to verify connectivity to this core.
URI: corecallback/connect
HTTP Method: GET
ICoreDiagnosticsManagement
This section describes the service operations available for ICoreDiagnosticsManagement at corediag/. 
The URI and HTTP method are provided for each service operation.
The service operations include:
•CollectServerLogs
•GetAggregateStatus
•GetDiskSubsystemStatus
•GetServerLogs
•GetServerLogsInfo
•GetSystemHWStatus 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B411 •StartGatheringDiagnosticInfo
•UploadLogSessions
CollectServerLogs
Starts collecting server logs by way of a background job.
URI: corediag/collectLogs
HTTP Method: POST
GetAggregateStatus
Gets aggregate system status from AMC provider.
URI: corediag/systemAggregateStatus
HTTP Method: GET
GetDiskSubsystemStatus
Gets disk subsystem status from AMC provider.
URI: corediag/diskSubsystemStatus
HTTP Method: GET
GetServerLogs
Gets the entire contents of archived server log files.
URI: corediag/serverLogs/
HTTP Method: GET
GetServerLogsInfo
Gets the name and UTC creation timestimp of current archive file with server logs.
URI: corediag/serverLogsArchiveName
HTTP Method: GET
GetSystemHWStatus
Gets system hardware status from AMC provider.
URI: corediag/systemHWStatus
HTTP Method: GET
StartGatheringDiagnosticInfo
Starts gathering diagnostic information by way of a background job and then returns the following response: 
StartGatheringDiagnosticInformationResponse.
URI: corediag/diagnostic-info/
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B412
UploadLogSessions
Uploads the current logs for the Core and all protected agents that are online to Gibraltar 
(http://www.gibraltarsoftware.com/) by way of a background job. Nothing is returned.
URI: corediag/logs/
HTTP Method: POST
ICoreMetadataManagement
This section describes the service operations available for ICoreMetadataManagement at metadata/. 
The ICoreMetadataManagement service contract is the interface implemented by the core metadata service, 
which maintains, caches, and returns core metadata.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetCached
•GetCachedSummary
•GetCurrent
•GetCurrentSummary
•GetStartupGuideFinished
•SetStartupGuideFinished
GetCached
Gets cached Core metadata.
URI: metadata/cached
HTTP Method: GET
GetCachedSummary
Gets cached Core summary metadata.
URI: metadata/cachedsummary
HTTP Method: GET
GetCurrent
Gets the current Core metadata.
URI: metadata/
HTTP Method: GET
GetCurrentSummary
Gets the current Core summary metadata.
URI: metadata/summary
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B413
GetStartupGuideFinished
Gets the value indicating whether to show startup guide.
URI: metadata/getStartupGuideFinished
HTTP Method: GET
SetStartupGuideFinished
Sets the value indicating whether to show setup wizard on startup.
URI: metadata/setStartupGuideFinished/{finished}
HTTP Method: POST
ICoreSettingsManagement
This section describes the service operations available for ICoreSettingsManagement at settings/. 
The ICoreSettingsManagement service contract provides a way to query and set assorted core-wide settings.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetClientTimeout
•GetCoreInstallPath
•GetCoreSettings
•SetClientTimeout
•SetCoreSettings
GetClientTimeout
Gets timeout settings which are used in REST and socket communication.
URI: settings/clientTimeout
HTTP Method: GET
GetCoreInstallPath
Get path to a directory where Agent and Local Mount Utility installers are located.
URI: settings/installersPath
HTTP Method: GET
GetCoreSettings
Gets general global Core settings such as timeout settings and display name.
URI: settings/core
HTTP Method: GET
SetClientTimeout
Applies timeout settings which are used in REST and socket communication.
URI: settings/clientTimeout
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B414
SetCoreSettings
Applies general global Core settings such as timeout settings and display name.
URI: settings/core
HTTP Method: PUT
IDatabaseStorageManagement
This section describes the service operations available for IDatabaseStorageManagement at databaseStorage/. 
The IDatabaseStorageManagement service contract is the interface for communication and configuration of 
persistant database storage used for events and reports info storing.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetDatabaseStorageConfiguration
•GetDefaultDatabaseStorageConfiguration
•SetDatabaseStorageConfiguration
•TestConnection
GetDatabaseStorageConfiguration
Gets database storage configuration (like database server connection settings, database data retention period, 
connection timeout).
URI: databaseStorage/configuration
HTTP Method: GET
GetDefaultDatabaseStorageConfiguration
Gets default database storage configuration.
URI: databaseStorage/defaults
HTTP Method: GET
SetDatabaseStorageConfiguration
Sets database storage configuration (like database server connection settings, database data retention period, 
connection timeout).
URI: databaseStorage/configuration
HTTP Method: PUT
TestConnection
Tests connection with database storage instance using specified connection settings.
URI: databaseStorage/connection
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B415
IDiagnosticsManagement
This section describes the service operations available for IDiagnosticsManagement at diag/. 
The URI and HTTP method are provided for each service operation.
The service operations include:
•ExecuteRemoteCommand
•GetLog
•GetLogSession
•ReadFile
•RestartService
•UploadLogSessions
ExecuteRemoteCommand
Runs an arbitrary remote command.
URI: diag/command/
HTTP Method: POST
GetLog
Gets the entire contents of the replay.log file.
URI: diag/log/
HTTP Method: GET
GetLogSession
Packages the current log session and returns it as a byte stream. The contents of the stream is a Gibraltar (.glp 
file).
URI: diag/logSession/
HTTP Method: GET
ReadFile
Reads a file from the local file system and streams it back to the client.
URI: diag/files/?q={path}
HTTP Method: GET
RestartService
Stops, forcibly kills (if necessary), and re-starts the service.
URI: diag/service/
HTTP Method: DELETE
UploadLogSessions
Uploads the current log session to the Gibraltar (http://www.gibraltarsoftware.com/) logging framework.
URI: diag/logSession/
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B416
IEmailsManagement
This section describes the service operations available for IEmailsManagement at emailsmgr/. 
The IEmailsManagementservice contract is the WCF contract interface for the Emails management.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetSmtpServerSettings
•IsConfigured
•SendTestEmail
•SetSmtpServerSettings
GetSmtpServerSettings
Returns SMTP server settings from emails service configuration.
URI: emailsmgr/settings
HTTP Method: GET
IsConfigured
Indicates whether SMTP server settings have been set by user.
URI: emailsmgr/settings/check
HTTP Method: GET
SendTestEmail
Generates and sends a test email using the specified email configuration.
URI: emailsmgr/config/test
HTTP Method: PUT
SetSmtpServerSettings
Sets SMTP server settings within emails service configuration.
URI: emailsmgr/settings
HTTP Method: PUT
IEncryptionKeyManagement
This section describes the service operations available for IEncryptionKeyManagement at encryption/. 
The IEncryptionKeyManagement service contract is the encryption key management used in conjunction with 
the repositories and dependent services.
The URI and HTTP method are provided for each service operation.
The service operations include:
•ChangeKeyStatusToReplication
•ChangeKeyStatusToUniversal
•ChangePassphrase
•Create 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B417 •DeleteKey
•Export
•GetFilteredKeys
•GetKeys
•Import
•LockKey
•SerializedExport
•SerializedImport
•UnlockKey
•UpdateDescription
ChangeKeyStatusToReplication
Changes key status to Replication Key. Returns updated key info.
URI: encryption/changeKeyStatusToReplication/{keyId}
HTTP Method: POST
ChangeKeyStatusToUniversal
Changes key status to Universal Key. Returns updated key info.
URI: encryption/changeKeyStatusToUniversal
HTTP Method: POST
ChangePassphrase
Changes the passphrase for the specified key.
URI: encryption/passphrase
HTTP Method: POST
Create
Creates a new key with the specified name and passphrase.
URI: encryption/
HTTP Method: POST
DeleteKey
Deletes an encryption key or throws exception if selected key is used.
URI: encryption/delete/{keyId}
HTTP Method: DELETE
Export
Exports a key.
URI: encryption/{keyId}
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B418
GetFilteredKeys
Gets the filtered list of encryption keys. Pass the type of the keys as parameter.
URI: encryption/
HTTP Method: GET
GetKeys
Gets the list of encryption keys.
URI: encryption/
HTTP Method: GET
Import
Imports an exported key. Returns imported key info.
URI: encryption/import
HTTP Method: POST
LockKey
Locks the specified key. Returns updated key info.
URI: encryption/lock/{keyId}
HTTP Method: POST
SerializedExport
Returns serialized binary representation of encryption key by given key ID.
URI: encryption/{keyId}/serialized
HTTP Method: GET
SerializedImport
Imports an encryption key by given serialized binary representation. Returns imported key info.
URI: encryption/serimport
HTTP Method: POST
UnlockKey
Unlocks the specified key. Returns updated key info.
URI: encryption/unlock
HTTP Method: POST
UpdateDescription
Updates existing key name and comment. Returns updated key info.
URI: encryption/{keyId}
HTTP Method: PUT