Service Contracts of Core

This page describes the service contracts contained in this client assembly.

Service Contract | Uri | Description
--- | --- | ---
IAgentDiagnosticsManagement | agentdiag/ | Replay.Core.Contracts.Agents.IAgentDiagnosticsManagement
IAgentsGroupsManagement | agentGroups/ | This interface allows working with certain features of groups of Rapid Recovery Agents. These features include retrieving all the groups of the Core, adding or removing a group to the Core, changing the name of an existing group on the Core, and adding or removing an Rapid Recovery Agent to a known group.
IAgentsManagement | agents/ | This interface allows working with Agents from a Core machine. Through this interface, all Agents known to the Core (both protected and unprotected) can be retrieved, as well as information about these Agents.
IAmazonSeedingManagement | amazonSeeding/ | Replay.Core.Contracts.AmazonSeeding.IAmazonSeedingManagement
IApplianceManagement | appliance/ | Represents the functionality that is common for physical and virtual appliances
IApplicationIdManagement | id/ | This interface allows retrieving the unique identifier of the Core.
IAutoReportManagement | autoReport/ | RESTful API for the auto report
IAutoUpdateManagement | autoupdate/ | This interface manages the auto-update feature of Core. Through this interface, the auto-update configuration can be retrieved and set. In addition, an update can be forced as well as the state of the update can be queried.
IAzureManagement | armmanagement/ | RESTful API for the Azure resource manager management .
IBackgroundJobManagement | jobmgr/ | This interface manages background jobs. Through this interface, jobs can be retrieved (1 or many) and canceled (both parent and child jobs). In addition, the configuration of background jobs can be retrieved and the settings for background jobs can be updated or reset via this interface.
IBackupManagement | backup/ | This interface manages backups, scheduled backups, and restores. Through this interface, backups and restores can be started and updated. In addition, scheduled backups can be paused, resumed, forced, or deleted; verification of backup and restore locations, as well as starting backup checks can be accomplished via this interface.
IBackupRepositoryManagement | backupRepository/ | This interface manages backup repositories. Through this interface, repositories information can be retrieved (either all repositories or by identifier); they can be mounted, un-mounted, created, or deleted. In addition, backup locations can be verified via this interface.
IBootCdBuilderManagement | bootcdbuilder/ | This interface works with the bootable CD build process. Through this interface, validation of driver packages and verification of ISO parameters can be achieved. In addition, starting and retrieving the status of the ISO building is possible via this interface.
ICloudCommunicationManagement | cloudCommunicationManagement/ | This interface allows working with the Cloud Communication settings.
ICloudManagement | cloud/ | This interface allows working with the Cloud provider settings. Through this interface, Cloud accounts can be retrieved, added, updated, and deleted as well as retrieving and setting the Cloud configuration. In addition, the ability to list containers, items, folders, and files is available via this interface.
IClustersManagement | clusters/ | This interface allows working with cluster nodes and agents. Through this interface, cluster nodes for cluster Agents can be added and retrieved. In addition, this interface exposes methods to convert a regular Agent to a cluster node and a cluster node to a regular Agent.
ICoreBackupRestoreManagement | corebackuprestore/ | This interface allows working Core configuration backups and restores. Through this interface, the Core's configuration can be backed up and restored (with or without a restart). In addition, the repositories can be read from a Core's backed up configuration via this interface.
ICoreCallbackManagement | corecallback/ | This interface allows an Agent to callback to the Core. Through this interface, a remote Agent can verify connectivity to the Core.
ICoreDiagnosticsManagement | corediag/ | This interface provides diagnostic features of Rapid Recovery. Through this interface, logs for the Core and all protected agents can be collected or uploaded to the log server. In addition, various types of diagnostic information can be gathered, including information about the server logs, the system hardware, disk subsystem status, and aggregate system status.
ICoreMetadataManagement | metadata/ | This interface allows working with Core metadata. Though this interface current as well cached Core metadata and summary can be retrieved. In addition, the option to show the Startup Guide can be retrieved and set via this interface.
ICoreSettingsManagement | settings/ | This interface allows working with Core-wide settings. Through this interface, settings such as timeouts and display name can be retrieved and set. In addition, the timeout used in REST and socket communications can be retrieved and set via this interface.
ICredentialsVaultManagement | credentialsVault/ | Management API for credentials in the Credentials Vault. Each Core has a single Credentials Vault.
IDashboardReportsManagement | dashboard/ | Interface implemented by dashboard reports management service used to perform dashboard reports
IDatabaseStorageManagement | databaseStorage/ | This interface allows communicating and configuring persistent database storage used for events and report information. Through this interface, the database storage configuration can be retrieved and set as well retrieving the default database configuration.
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.
IDvmPerformanceLoggingManagement | dvmPerformanceLogging/ | This interface allows configuring the performance logging of the DVM. Through this interface, the settings can be retrieved and set.
IEmailsManagement | emailsmgr/ | This interface allows configuring SMTP settings. Through this interface, SMTP server settings can be retrieved and set as well queried to determine if the settings have been configured. In addition, a test email can be sent via this interface.
IEncryptionKeyManagement | encryption/ | This interface allows working with the encryption keys used in conjunction with repositories and dependent services. Through this interface, encryption keys can be retrieved (all or a filtered subset), created, updated, imported, exported, locked, unlocked, and deleted. In addition, the passphrase for a specified key, the status for a replication key, and the status for the universal key can be changed via this interface.
IEventsManagement | events/ | This interface allows working with events and alerts. Through this interface, event configuration and Agent alerts settings can be retrieved and set. In addition, a test email similar to an email sent if event email notification is configured can be sent via this interface. The Core and Agent events and alerts can be worked with additional granularity including retrieving all events or a subset of events.
IExchangeManagement | exchange/ | This interface allows managing a Microsoft Exchange server on the protected machine. Through this interface, the Exchange server settings on the Agent machine can be retrieved and set. In addition, the mountability of the recovery points can be verified.
IExportQueueManagement | export/queue/ | This interface allows working with the VM export queue. Through this interface, the configuration for the export queue can be retrieved and set. In addition, the contents of the export queue can be retrieved, all exports or subset of exports in queue can be canceled via this interface.
IExportSchedulerManagement | export/schedule/ | This interface allows working with the VM export scheduler. Through this interface, the Agent export configuration can be retrieved (for all agents), set, and deleted for an Agent. In addition, an export can be forced, Agent export status can be queried, and various settings related to exporting can be validated via this interface.
IFeatureTogglesManagement | featureToggles/ | Exposes the feature toggles management API.
IFileSearchManagement | fileSearch/ | This interface allows to search for individual files in a range of recovery points.
IFoglightManagement | foglight/ | WCF contract interface for Foglight management.
IFtbuApplianceManagement | FtbuAppliance/ | Represents the functionality related to FTBU
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.
IHyperVManagement | hyperv/ | Exposes the HyperV management API
IIsoDatabaseManagement | bootcdbuilder/ | This interface allows working with ISO files that were created. Through this interface, all previously created ISO files can be retrieved and a specific ISO file can be deleted.
ILicenseManagement | license/ | This interface allows working with license management service. Through this interface, license information for the Core and a specified Agent can be retrieved. In addition, checking the state of a phone home operation, verifying if phone home is enabled, or forcing a phone home operation can be achieved via this interface.
ILocalizationManagement | localization/ | This interface allows working with the culture setting which determine the language and locale. Through this interface, the current culture setting can be retrieved or set, as well retrieving a list of all supported cultures.
ILocalMountManagement | mounts/ | This interface allows working with mounted volume images on the local Core. Through this interface, mounts can be started and previous mounts can be retrieved (either all mounts or a subset of mounts). In addition, a mounted volume, all mounted volumes, or a subset of mounted volumes can be dismounted via this interface.
ILoggingManagement | logs/ | This interface allows working with trace logging configuration. Through this interface, trace logging for either a specified category or all log categories can be enabled or disabled.
ILogTruncationManagement | logtruncation/ | This interface allows forcing the log truncation job for a specified agent.
IMailboxRestoreManagement | mailboxRestore/ | Exposes the mail restore management API.
INetworkScannerManagement | networkScanner/ | This interface allows to scan Local Area Network or Active Directory to get information about neighbor computers.
INightlyJobsManagement | nightlyJobs/ | This interface allows working with nightly jobs. Through this interface, settings for nightly jobs and the configuration of a specific Agent job can be retrieved and set. In addition, the status of nightly jobs can be retrieved and the status of nightly jobs can be checked via this interface.
IO3EPhantomAgentMigrationManagement | o3ePhantomAgentMigrationManagement/ | Interface implemented by the repository migration service, which handles operations related to migration from DVM to O3E repositories
IO3EPhantomDeploymentManagement | o3ePhantomDeploymentManagement/ | Responsible deployment of ocarina service to remote server
IO3EPhantomManagement | o3ePhantomManagement/ | Interface implemented by the O3E management service, which handles core operations related to O3E library and O3E repositories.
IO3EPhantomServerManagement | o3ePhantomServerManagement/ | Interface implemented by the O3E server management, which handles operations related to O3E server.
IOperatingSystemManagement | operatingSystem/ | Represents an entry point for functionality related to Operating System configuration and management
IOracleDatabaseRecoveryPointsManagement | oracleDatabaseRecoveryPoints/ | This interface allows working with Oracle Database recovery points. Through this interface, Oracle Database recovery points can be retrieved or deleted
IOracleManagement | oracle/ | This interface manages how Oracle databases are handled.
IProtectedItemsManagement | protectedItems/ | This interface allows retrieving the protected items tree. Protected items can include Agents, clusters, cluster nodes, and groups.
IPushInstallCommunication | pushinstallcomm/ | This interface allows communicating between the Core and PushInstall agent. INTERNAL USAGE ONLY
IPushInstallManagement | pushinstall/ | This interface allows managing the PushInstall functionality of Rapid Recovery. Through this interface, the configuration for the PushInstall feature can be retrieved or set, Agents can be deployed, and a machine can be validated prior to attempting to PushInstall an Agent to that machine.
IRecoveryPointsManagement | recoveryPoints/ | This interface allows working with recovery points. Through this interface, recovery points can be retrieved or deleted as well as checking if a recovery point is orphaned. In addition, volume images can be checked or exported via this interface.
IRemoteMountManagement | remoteMounts/ | This interface allows managing remote mounted volume images. Through this interface, volume images on remote machines can be mounted and un-mounted.
IReplayEngineManagement | replayEngine/ | This interface allows configuring and monitoring the Replay Engine. Through this interface, the Replay Engine configuration can be retrieved and set. In addition, all active connections to the Replay Engine can be retrieved and a specified active connection can be closed via this interface.
IReplicationCommunication | replicationcomms/ | This interface allows communication between Cores for replication. INTERNAL USAGE ONLY
IReplicationManagement | replication/ | This interface allows the configuration, management, and monitoring of replication between Cores.
IReportingManagement | report/ | Interface implemented by core reports management service, which provides reporting functionality
IRepositoryManagement | reposManagement/ | This interface allows working with repositories. Through this interface, the configuration of the repository service can be retrieved and set. In addition, repositories can be created, checked, and deleted as well as various operations on existing repositories via this interface.
IRollbackManagement | rollback/ | This interface allows working with the Restore service. Through this interface, a restore job can be created, information about a restore target can be retrieved, as well as validation or verification of certain aspects of the Restore process.
IRollupManagement | rollup/ | This interface allows working with rollup operations. Through this interface, the configuration of the rollup operations can be retrieved and set. In addition, a rollup operation can be forced via this interface.
ISeedDriveManagement | seedDrive/ | This interface allows working seed drive management service, which provides a copy-consume functionality from the Replay engine. Through this interface, seed drives can be copied or consumed. In addition, seed drives that are waiting to be consumed can be abandoned via this interface.
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.
ISnmpManagement | snmp/ | WCF contract interface for SNMP management.
ISqlManagement | sql/ | This interface manages how Microsoft SQL Server databases are handled. Through this interface, the attachability settings for SQL servers can be retrieved and set. In addition, attachability can be forced. SQL connections can be tested via this interface as well.
IStatusSummaryManagement | status/ | This interface allows retrieving of status information about multiple services in the Core. Through this interface, information such as Core system information, failed services information, and latest Core event information. In addition, the ability to attempt to restart failed services is available via this interface.
ITapeBackupManagement | tapeBackup/ | Replay.Core.Contracts.Tapes.ITapeBackupManagement
ITransferQueueManagement | xfer/queue/ | This interface allows working with the transfer queue. Through this interface, the contents of the transfer queue can be retrieved, all transfers or subset of transfers in queue can be canceled via this interface. In addition, the priority of transfers within the queue can be changed via this interface.
ITransferSchedulerManagement | xfer/schedule/ | This interface allows working with the transfer scheduler. Through this interface, the transfer configuration for a specified Agent can be retrieved or set. In addition, Agent protection can be paused and resumed as well as retrieving, adding, and modifying scheduled transfers via this interface.
IUtilitiesManagement | utilities/ | This interface allows access to some helper methods. Through this interface, all machines from Active Directory (either all or by page) and domain information can be retrieved.
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.
IVirtualApplianceManagement | virtualAppliance/ | This interface allows to work with the virtual appliance.
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.
IVSphereManagement | vsphere/ | Exposes the VSphere management API
IWhiteLabelingManagement | whitelabeling/ | This interface allows retrieving the customizable strings in Rapid Recovery.