Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B489
TranslateSectorOffsetToChsTuple
Translates sector offset to chs tuple.
URI: vhd/{id}/translateSectorOffsetToChsTuple?sectorOffset={sectorOffset}
HTTP Method: GET
Write
Writes raw data to VHD.
URI: vhd/{id}/write/{target}/{sectorOffset}/{sectorLength}
HTTP Method: POST
WriteCustomMetadata
Reads a user-defined custom metadata string.
URI: vhd/{id}/writeCustomMetadata/{target}/{key}?value={value}
HTTP Method: POST
IWhiteLabelingManagement
This section describes the service operations available for IWhiteLabelingManagement at whitelabeling/. The 
IWhiteLabelingManagement service contract exposes the customizable strings.
The URI and HTTP method are provided for the service operation is as follows:
•GetWhiteLabelingInfo
GetWhiteLabelingInfo
Gets customizable strings.
URI: whitelabeling/whiteLabelingInfo
HTTP Method: GET
Using AppAssure Agent API
The AppAssure Agent API is grouped according to the following categories/service interfaces. Click a category 
below to get more information about the service operations available for a particular interface.
The service contracts contained in the Agent client assembly are described in the following table:
Table 2. Agent service contracts
Service Contract Uri Description
IAgentMetadataManagementmetadata/ Interface implemented by the agent metadata 
service, which maintains, caches, and returns 
agent metadata.
IAgentPairManagementpair/ Interface implemented by the agent pairing 
service, which provides pairing functionality 
on the agents.
IAgentServiceHostManagementagentServiceHost/ Interface implemented by the Agent service, 
which performs actions related to the Agents 
ServiceHost. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B490
IAgentMetadataManagement
This section describes the service operations available for IAgentMetadataManagement at metadata/. 
The IAgentMetadataManagement interface is implemented by the agent metadata service, which maintains, 
caches, and returns agent metadata.
The URI and HTTP method are provided for each service operation.
The service operations include:
•GetCurrent
•GetCurrentCluster
•GetCurrentClusterSummary IAgentSettingsManagementsettings/ Provides a way to query and set assorted 
agent-wide settings.
IAgentUpdateManagementupdate/ Interface implemented by the agent update 
service, which downloads and installs updates.
IApplicationIdManagementid/ Exposes the applications unique ID.
IDiagnosticsManagementdiag/ Replay.Common.Contracts.Diagnostics.IDiagno
sticsManagement
IDriverChangeLogsManagementdriverchangelogs/ Provides an ability to manage AAFsFlt change 
logs: enumerate, delete, control volume 
enablement.
IExchangeManagementexchangedll/ Provides possibility to upload MS Exchange 
DLLs to Core.
IExchangeServerManagementexchangeServer/ Provides possibility to run the command over 
the Exchange Server installed on the physical 
machine.
IHyperVAgentManagementhypervagent/ Replay.Common.Contracts.Virtualization.IHyp
erVAgentManagement.
IPowerShellManagementpowerShell/ Interface allows to run the script with 
parameters from file.
IRollbackManagementrollback/ REST service which exposes methods to 
initiate restoring data from a recovery point 
on an agent.
IRrcRollbackManagementrollback/ REST service which exposes methods to 
initiate restoring data from a recovery point 
on an agent.
IServiceHostManagementservicehost/ Interface implemented by a class which 
provides a management interface to the 
IServiceHost.
IShadowCopyManagementshadowcopy/ Exposes some diagnostic information about the 
Volume Shadow Copy service (VSS).
ITransferManagementtransfer/ WCF contract interface implemented by a 
class which implements the management 
interface on top of the transfer service.
IVirtualDiskManagementvhd/ Replay.Common.Contracts.Virtualization.IVirtu
alDiskManagement
IWhiteLabelingManagementwhitelabeling/ Exposes the customizable strings. Table 2. Agent service contracts
Service Contract Uri Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B491 •GetCurrentDeduplicationJobs
•GetCurrentSummary
•VerifyCredentials
GetCurrent
Gets cached full metadata for the agent.
URI: metadata/fullMetadata
HTTP Method: PUT
GetCurrentCluster
Gets cached full metadata for the agent.
URI: metadata/fullClusterMetadata
HTTP Method: PUT
GetCurrentClusterSummary
Gets cached full metadata for the agent.
URI: metadata/fullClusterSummaryMetadata
HTTP Method: PUT
GetCurrentDeduplicationJobs
Gets the list of currently active deduplication jobs.
URI: metadata/currentDeduplicationJobs
HTTP Method: GET
GetCurrentSummary
Gets cached summary metadata for the agent with MS Exchange and SQL servers metadata.
URI: metadata/summaryMetadata
HTTP Method: PUT
VerifyCredentials
Verifies specified credentials for MS Exchange and SQL servers.
URI: metadata/credentials
HTTP Method: PUT
IAgentPairManagement
This section describes the service operations available for IAgentPairManagement at pair/. 
The IAgentPairManagement interface is implemented by the agent pairing service, which provides pairing 
functionality on the agents.
The URI and HTTP method are provided for each service operation. The service operations include:
•GetPairingSettings
•Pa i r 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B492 •RemovePairing
•VerifyConnect
•VerifyConnectWithOptionalAuthentication
GetPairingSettings
Gets pairing settings of the Agent which includes agent ID, paired Core name and security certificate 
thumbprints.
URI: pair/
HTTP Method: GET
Pair
Sets up relationship between a Core and the Agent including security certificates exchange.
URI: pair/
HTTP Method: PUT
RemovePairing
Removes relationship between the Agent and a Core.
URI: pair/
HTTP Method: DELETE
Ve r i f y C o n n e c t
Allows to verify connection to specified agent and returns actual agent ID.
URI: pair/connect
HTTP Method: GET
VerifyConnectWithOptionalAuthentication
Allows to verify connection to specified agent with optional authentication scheme and returns actual agent ID.
URI: pair/connect/?useNtlmOnly={useNtlmOnly}
HTTP Method: GET
IAgentServiceHostManagement
This section describes the service operations available for IAgentServiceHostManagement at agentServiceHost/. 
The IAgentServiceHostManagement interface is implemented by the Agent service, which performs actions 
related to the Agents ServiceHost.
The URI and HTTP method are provided for each service operation is as follows:
•ChangePort 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B493
ChangePort
Changes port number used by server which listens for incoming REST calls.
URI: agentServiceHost/port
HTTP Method: POST
IAgentSettingsManagement
This section describes the service operations available for IAgentSettingsManagement at settings/. 
The IAgentSettingsManagement service contract provides a way to query and set assorted agent-wide settings.
The URI and HTTP method are provided for each service operation. The service operations include:
•GetAgentSettings
•SetAgentSettings
GetAgentSettings
Gets general global Agent settings such as timeout settings and display name.
URI: settings/agent
HTTP Method: GET
SetAgentSettings
Applies general global Core settings such as timeout settings and display name.
URI: settings/agent
HTTP Method: PUT
IAgentUpdateManagement
This section describes the service operations available for IAgentUpdateManagement at update/. 
The IAgentUpdateManagement interface is implemented by the agent update service, which downloads and 
installs updates.
The URI and HTTP method are provided for each service operation is as follows:
•ApplyUpdate
ApplyUpdate
Performs automatic update of Agent service binaries. This method is for internal usage only and should not be 
called by users.
URI: update/
HTTP Method: POST
IApplicationIdManagement
This section describes the service operations available for IApplicationIdManagement at id/. 
The IApplicationIdManagement exposes the application’s unique ID.
The URI and HTTP method are provided for each service operation is as follows:
•GetId 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B494
GetId
Gets the cores ID.
URI: id/
HTTP Method: GET
IDiagnosticsManagement
This section describes the service operations available for IDiagnosticsManagement at diag/. 
The IDiagnosticsManagement service contract is represented as 
Replay.Common.Contracts.Diagnostics.IDiagnosticsManagement.
The URI and HTTP method are provided for each service operation. The service operations include:
•ExecuteRemoteCommand
•GetLog
•GetLogSession
•ReadFile
•RestartService
•UploadLogSessions
ExecuteRemoteCommand
Executes 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 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B495
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
IDriverChangeLogsManagement
This section describes the service operations available for IDriverChangeLogsManagement at driverchangelogs/. 
The IDriverChangeLogsManagement provides an ability to manage AAFsFlt change logs: enumerate, delete, 
control volume enablement.
The URI and HTTP method are provided for each service operation. The service operations include:
•DeleteDriverChangeLogFile
•DisableVolumeLogging
•EnableVolumeLogging
•EnumerateDriverChangeLogs
DeleteDriverChangeLogFile
Deletes a specified change log file for a volume.
URI: driverchangelogs/{volumeName}/{changeLogFile}
HTTP Method: DELETE
DisableVolumeLogging
Disables logging FS changes for a volume.
URI: driverchangelogs/{volumeName}/disablelogging
HTTP Method: POST
EnableVolumeLogging
Enables logging FS changes for a volume.
URI: driverchangelogs/{volumeName}/enablelogging
HTTP Method: POST
EnumerateDriverChangeLogs
Gets a collection of change log files for a volume.
URI: driverchangelogs/{volumeName}/
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B496
IExchangeManagement
This section describes the service operations available for IExchangeManagement at exchangedll/. 
The IExchangeManagement provides possibility to upload MS Exchange DLLs to Core.
The URI and HTTP method are provided for each service operation. The service operations include:
•CancelTransmitFile
•ContinueTransmitFile
•EndTransmitFile
•GetExchangeDllInfo
•StartNewFileTransmitSession
CancelTransmitFile
Cancels current transmit session.
URI: exchangedll/sessions/{fileTransmitSessionId}/
HTTP Method: DELETE
ContinueTransmitFile
Reads data from agent in current transmit session.
URI: exchangedll/sessions/{fileTransmitSessionId}/data/{bytesToRead}
HTTP Method: POST
EndTransmitFile
Ends current transmit session.
URI: exchangedll/sessions/{fileTransmitSessionId}/
HTTP Method: POST
GetExchangeDllInfo
Gets information about MS Exchange library.
URI: exchangedll/{fileName}/
HTTP Method: GET
StartNewFileTransmitSession
Starts new file transmit session.
URI: exchangedll/newsession/
HTTP Method: POST
IExchangeServerManagement
This section describes the service operations available for IExchangeServerManagement at exchangeServer/. 
The IExchangeServerManagement provides possibility to execute command over the Exchange Server installed 
on the physical machine. 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B497 The URI and HTTP method are provided for each service operation. The service operations include:
•CancelExchangeServerCommand
•ExecuteExchangeServerCommand
•GetExchangeServerCommandStatus
CancelExchangeServerCommand
Cancels the running command.
URI: exchangeServer/cancelCommand
HTTP Method: DELETE
ExecuteExchangeServerCommand
Gracefully performs start/stop of the Exchange Server.
URI: exchangeServer/executeCommand
HTTP Method: PUT
GetExchangeServerCommandStatus
Queries the status of the current start/stop operation of the Exchange Server.
URI: exchangeServer/getCommandStatus
HTTP Method: GET
IHyperVAgentManagement
This section describes the service operations available for IHyperVAgentManagement at hypervagent/. 
The IHyperVAgentManagement service contract is represented as 
Replay.Common.Contracts.Virtualization.IHyperVAgentManagement.
The URI and HTTP method are provided for each service operation. The service operations include:
•AddDvdDrive
•AddIsoImage
•AddNetworkAdapter
•AttachVirtualDisk
•DeleteVirtualMachine
•DetachVirtualDisk
•EndSession
•GetAvailableVirtualNetworks
•GetMaximumProcessorCount
•GetOrCreateVirtualMachineAndAttach
•GetSnapshotsCount
•GetVirtualDisks
•GetVirtualMachineName
•InsertIntegrationServices
•Pi n gSe ss i on 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B498 •RenameVirtualMachine
•SetProcessorCount
•SetRamMegabytes
•VerifyConnection
AddDvdDrive
Adds a DVD drive to current virtual machine.
URI: hypervagent/{virtualMachineId}/dvd
HTTP Method: PUT
AddIsoImage
Adds an ISO image to a DVD drive. If DVD drive doesnt exist - creates it.
URI: hypervagent/{virtualMachineId}/iso/{isoPath}
HTTP Method: PUT
AddNetworkAdapter
Adds new network adapter to current virtual machine.
URI: hypervagent/{virtualMachineId}/nic/{networkAdapterName}
HTTP Method: PUT
AttachVirtualDisk
Attaches a virtual disk to current virtual machine.
URI: hypervagent/{virtualMachineId}/disks/{diskPath}/{storageController}
HTTP Method: PUT
DeleteVirtualMachine
Deletes current virtual machine and detaches from it.
URI: hypervagent/existent/{virtualMachineId}
HTTP Method: DELETE
DetachVirtualDisk
Detaches a virtual disk from current virtual machine.
URI: hypervagent/{virtualMachineId}/disks/{diskPath}
HTTP Method: DELETE
EndSession
Tells Hyper-V Agent to finish session with the virtual machine.
URI: hypervagent/{virtualMachineId}/endsession
HTTP Method: DELETE