Service Contracts of Agent
This page describes the service contracts contained in this client assembly.
| Service Contract | Uri | Description |
|---|---|---|
| IAgentMetadataManagement | metadata/ | This interface allows retrieving both the full and summary metadata for Rapid Recovery Agents and Clusters. In addition to retrieving metadata, this interface verifies Microsoft Exchange or SQL Server credentials as well retrieves a list of currently active de-duplication jobs. |
| IAgentPairManagement | pair/ | This interface allows manipulating the pairing of an Rapid Recovery Agent and Core. The features supported include pairing and un-pairing an Agent with a Core. In addition, verification of the connection between a paired Agent and Core and retrieving the pairing settings are supported via this interface. |
| IAgentServiceHostManagement | agentServiceHost/ | This interface allows manipulating the ServiceHost of an Rapid Recovery Agent. The port number used by the Agent to listen for incoming REST calls can be set. |
| IAgentSettingsManagement | settings/ | This interface allows querying and setting Rapid Recovery Agent settings. |
| IApplicationIdManagement | id/ | This interface allows retrieving the unique identifier of the Core. |
| ICloudTransferManagement | transferdirecttocloud/ | WCF contract interface implemented by a class which implements the management interface on top of the transfer service. This actually covers direct-to-cloud transfers implementation |
| IDiagnosticsManagement | diag/ | This interface allows working with certain diagnostic features of Rapid Recovery. These features include the retrieval of the application logs, uploading of the session logs to the log server, and restarting of the Rapid Recovery service. |
| IDriverChangeLogsManagement | driverchangelogs/ | This interface allows managing of the AAFsFlt change logs. Through this interface volume logging can be enabled and disabled. The volume change logs can be retrieved or deleted via this interface. |
| IExchangeManagement | exchangedll/ | Provides possibility to upload MS Exchange DLLs to Core. |
| IExchangeServerManagement | exchangeServer/ | This interface allows executing commands over the Exchange Server installed on the physical machine (non virtual machine). |
| IHyperVAgentManagement | hypervagent/ | This interface allows interacting with a running HyperV Agent. Through this interface, virtual machines can be retrieved, created, or deleted. In addition, various settings of a specified virtual machine can be modified via this interface. |
| IHyperVAgentSettingsManagement | hyperVsettings/ | This interface allows querying and setting Rapid Recovery Agent settings. |
| IHyperVCloudTransferManagement | hypervCloudTransfer/ | WCF contract interface implemented by a class which implements the management interface on top of the transfer service. This actually covers hyperv cloud transfers implementation |
| IHyperVMachineMetadataManagement | hypervMachine/ | Interface implemented by the agent metadata service, which maintains, caches, and returns agent metadata. |
| IHyperVManagement | hypervManagement/ | Provides possibilities to start general hyper-v agentless related operations |
| IHyperVPairManagement | hyperVpair/ | This interface allows manipulating the pairing of an Rapid Recovery Core and Hyper-V virtual machines. The features supported include pairing and un-pairing a Hyper-V virtual machine with a Core. |
| IHyperVProtectionManagement | hypervFileProtection/ | WCF contract interface implemented by a class which implements the management interface on top of the HyperV protection service. |
| IHyperVRollbackManagement | hyperVRollback/ | REST service which exposes methods to initiate rollbacks on a Hyper-V virtual machine |
| IHyperVServerMetadataManagement | hypervServerMetadata/ | Interface implemented by the hyoerv metadata service, which maintains, caches, and returns server metadata. |
| IHyperVTransferManagement | hypervMachineTransfer/ | WCF contract interface implemented by a class which implements the management interface on top of the transfer service. |
| IHyperVTransferManagementDirectToTarget | hypervTransferDirectToTarget/ | WCF contract interface implemented by a class which implements the management interface on top of the transfer service. This actually covers hyperv direct-to-target transfers implementation |
| INetworkScannerManagement | networkScanner/ | This interface allows to scan Local Area Network or Active Directory to get information about neighbor computers. |
| IOperatingSystemManagement | operatingSystem/ | Represents an entry point for functionality related to Operating System configuration and management |
| IOracleManagement | oracle/ | WCF contract interface implemented by a class which implements the management interface on top of the Oracle Truncation Service. |
| IPowerShellManagement | powerShell/ | This interface allows executing PowerShell scripts on the Agent machine. The scripts that can be executed are either pre or post certain types of jobs such as export, transfer, nightly, backup, restore, and restore reading segment. |
| IRollbackManagement | rollback/ | REST service which exposes methods to initiate rollbacks on an agent |
| IRrcRollbackManagement | rollback/ | This interface allows initiating restores on an Agent. |
| IServiceHostManagement | servicehost/ | This interface allows working with the Service Host. Through this interface, the configuration for a server listening for incoming REST calls can be set or retrieved. |
| IShadowCopyManagement | shadowcopy/ | This interface allows retrieving of some diagnostic information about the Volume Shadow Copy service (VSS). |
| ISqlManagement | sqlserver/ | Provides possibility to manage SQL server from Core. |
| ITransferManagement | transfer/ | This interface allows working with the Transfer service. Through this interface snapshots of protected machines can be taken or deleted. Information about a snapshot can also be retrieved. |
| ITransferManagementDirectToTarget | transferdirecttotarget/ | WCF contract interface implemented by a class which implements the management interface on top of the transfer service. This actually covers direct-to-target transfers implementation |
| IVddkApiManagement | vddk/ | This interface allows working with a virtual disk via a network. Through this interface, operations like creating, opening, closing, reading from, and writing to a virtual disk are possible. |
| IVirtualDiskManagement | vhd/ | This interface allows working with a virtual disk via a network. Through this interface, operations like creating, opening, closing, reading from, and writing to a virtual disk are possible. |
| IWhiteLabelingManagement | whitelabeling/ | This interface allows retrieving the customizable strings in Rapid Recovery. |