Operations at AgentsManagement
This page describes the backend methods at this endpoint.
| Signature | Description |
|---|---|
| AgentInfoSummary AddAgent(AddAgentRequest addAgentRequest) | Adds an agent that isn't currently protected, pairs with the agent and writes it's protection configuration. |
| AddAgentsResponse AddAgents(AddProtectedAgentsRequest addProtectedAgentsRequest) | Adds the specified agents that are not currently protected. The agents are paired with and their protection configuration is written |
| AgentInfoSummary AddAgentWithVolumeGroupsValidation(AddAgentRequest addAgentRequest) | Adds an agent that isn't currently protected, pairs with the agent and writes it's protection configuration, validates protection groups. |
| Void AssociateAgentsWithHypervisor(AssociateAgentsRequest associateAgentsRequest) | Associates agents with the specified hypervisor. |
| Void ChangeAgentDescriptor(String agentId, AgentDescriptor agentDescriptor) | Changes the descriptor used for an existing agent, so the core will use a new caller-specified URI and credentials. |
| Void ChangeDisplayName(String agentId, String newDisplayName) | Changes the display name used by the GUI for a given Agent. |
| Void ChangeHostName(String agentId, String newHostName) | Changes the host name used in connecting to a given Agent. |
| Void ChangeOperatingSystem(String agentId, String operatingSystemFamily) | Sets specified OS Version (from the 'OperatingSystemFamily' enum) for the Hyper-V host-based agent. Other types are not supported. |
| Void ChangePort(String agentId, AgentPortChangeRequest portChangeRequest) | Changes port used in connecting to a given Agent. |
| AgentPairingCheckResult CheckAgentPairing(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and checks if the agent is paired to this core or any core at all. |
| Void DeleteAgent(String agentId, DeleteAgentRequest deleteAgentRequest) | Deletes an agent from the core, optionally deletes the agent's recovery points and disables the agent's volumes as well. |
| Void DeleteAgents(DeleteAgentsRequest deleteAgentsRequest) | Deletes agents from the core, optionally deletes the agent's recovery points and disables the agent's volumes as well. |
| Void DissociateAgentsFromHypervisor(StringCollection agentsIdentifiers) | Dissociate agents from hypervisor. |
| AgentInfo FindAgentById(String agentId) | Finds the information about an agent protected by Replay if it exists. |
| AgentInfo FindAgentByNameOrIpAddress(String nameOrIpAddress) | Finds an agent by its display name, host name or IP address. |
| AgentInfoCollection FindAgentsForAssociationWithHypervisor(String hypervisorAgentId) | Finds virtual machines hosted by the hypervisor that are protected by the Core with the agent. |
| AgentInfoSummary FindHypervisorForAssociationWithAgent(String agentId) | Finds hypervisor for association with agent. |
| Void ForceAgentMetadataRefresh(String agentId) | Forces metadata refresh for agent with specified Id |
| Void ForceAgentOracleMetadataRefresh(String agentId) | Forces Oracle metadata refresh for agent with specified Id |
| Void ForceAgentsMetadataRefresh(AgentIdsCollection agentIds) | Forces metadata refresh for several agents with specified Ids |
| AgentDescriptorCollection GetAgentDescriptors() | Gets simply information about the Agent. |
| AgentDetailsInfo GetAgentDetails(String agentId) | Gets all information required to display the Agent Details page in the GUI. |
| AgentDetailsInfoCollection GetAgentDetailsBulk(String startIndex, String count) | Gets details for a range of agents. |
| AgentFeatures GetAgentFeatures(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's features. |
| AgentInfo GetAgentInfo(String agentId) | Gets the information about an agent protected by Replay. |
| AgentInfo GetAgentInfoByRepository(String repositoryId, String agentId) | Gets the information about an agent protected by Replay. |
| AgentInfoCollection GetAgentInfos(AgentIdsCollection agentIds) | Gets a list of agents info for specific agents |
| AgentInfoSummaryCollection GetAgentInfoSummaries() | Gets a list of info summary data contracts for each (protected, replicated and replay only) agent. This is an extremely lightweight method that does not perform any metadata-related REST calls and provides very limited information |
| AgentMetadata GetAgentMetadata(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's metadata. |
| AgentMetadata GetAgentMetadataById(String agentId) | Gets the latest metadata for an agent protected by Replay. |
| MetadataCredentials GetAgentMetadataCredentials(String agentId) | Gets credentials which used for metadata retrival for agent with specified Id |
| AgentOperatingSystem GetAgentOperatingSystem(AgentOperatingSystemRequest agentOperatingSystemRequest) | Gets operating system details for the agent from the recovery point if ID is specified or from the metadata. |
| AgentInfoCollection GetAgents() | Gets a list of all agents known to the core. |
| Int32 GetAgentsCount() | Get the total number of machines handled by the Core, including protected agents, agentless, recovery points only and replicated machines. |
| AgentMetadataCredentialsCollection GetAgentsMetadataCredentials(AgentIdsCollection agentIds) | Gets credentials which used for metadata retrival for set of agents with specified Ids |
| AgentSummaryInfo GetAgentSummaryInfo(String agentId) | Gets summary agent information including summary metadata, recent associated alerts and recent recovery points. |
| AgentSummaryMetadata GetAgentSummaryMetadata(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's summary metadata. |
| AgentSummaryMetadata GetAgentSummaryMetadataById(String agentId) | Gets latest summary metadata for an agent protected by Core. |
| AgentSummaryMetadata GetAgentSummaryMetadataFromLastRp(String agentId) | Gets summary metadata for an agent from last recovery point. |
| VolumeGroupsCollection GetAgentVolumeGroupsAvailableForProtection(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the list of volumes which are available for protection, grouped to reflect protection dependencies. It is possible that an agent and a core are installed on the same machine so a resulting list would not contain volumes which contain core repository data or metadata directories. For regular cases this list would be identical to a list of volumes returned in metadata. |
| VolumesCollection GetAgentVolumesAvailableForProtection(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the list of volumes which are available for protection. It is possible that an agent and a core are installed on the same machine so a resulting list would not contain volumes which contain core repository data or metadata directories. For regular cases this list would be identical to a list of volumes returned in metadata. |
| AgentMetadata GetBackupAgentMetadata(String agentId, String repositoryId) | Gets metadata for agent in mounted backup repositository. |
| AgentMetadata GetCachedAgentMetadataById(String agentId) | Gets cached metadata for an agent protected by Replay. |
| AgentSummaryMetadata GetCachedAgentSummaryMetadataById(String agentId) | Gets cached summary metadata for an agent protected by Replay. |
| GetVssWritersResponse GetCachedWriters(String agentId) | Gets cached information about VSS writers installed on the agent. |
| GetVssWritersResponse GetExcludedWriters(String agentId) | Gets information about VSS writers that are excluded during transfer. |
| AgentPairingSettings GetPairingSettings(AgentDescriptor agentDescriptor) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's pairing information. |
| AgentInfoCollection GetProtectedAgents() | Gets a list of protected agents known to the core. |
| AgentInfoCollection GetProtectedAgentsByIds(AgentIdsCollection agentIds) | Gets a list of protected agents known to the core by ids. |
| AgentInfoCollection GetProtectedAgentsByPage(String agentsPerPage, String pageNumber, AgentInfoFilter filterCriteria) | Gets a paged list of protected agents known to the core. |
| Int32 GetProtectedAgentsCount(AgentInfoFilter filterCriteria) | Get protected agents number. |
| AgentInfoSummaryCollection GetProtectedAgentsSummaries() | Gets a list of protected agents summaries known to the core. |
| AgentInfoCollection GetRecoveryPointsOnlyAgents() | Gets a list of recovery points' only agents |
| AgentInfoCollection GetRecoveryPointsOnlyAgentsByPage(String agentsPerPage, String pageNumber) | Gets a paged list of recovery points' only agents |
| Int32 GetRecoveryPointsOnlyAgentsCount() | Get recovery points only agents number. |
| AgentInfoSummaryCollection GetRecoveryPointsOnlyAgentsSummaries() | Gets a list of recovery points' only agents summaries |
| AgentInfoCollection GetReplicatedAgents() | Gets a list of replicated agents known to the core. |
| AgentInfoCollection GetReplicatedAgentsByPage(String agentsPerPage, String pageNumber) | Gets a paged list of replicated agents known to the core. |
| Int32 GetReplicatedAgentsCount() | Get replicated agents number. |
| AgentInfoSummaryCollection GetReplicatedAgentsSummaries() | Gets a list of replicated agents summaries known to the core. |
| GetVssWritersResponse GetWriters(String agentId) | Gets detailed information about VSS writers installed on the agent. |
| Boolean IsAgentAlreadyProtectedWithAnotherType(AgentDescriptor agentDescriptor) | Verifies if agent already protected with another type |
| Boolean IsChangingRepositoryAllowed(String agentId) | Verify if changing repository is allowed for current agent |
| Boolean IsClusterAddress(AgentDescriptor agentDescriptor) | Verify if provided address is cluster |
| Void RepairAgent(RepairAgentRequest request) | Repair agent previously protected by this core |
| Void RepairPairing(AgentDescriptor agentDescriptor) | Attempts to re-establish pairing with an agent already protected by the core, possibly using new credentials. |
| Void SetAgentMetadataCredentials(String agentId, MetadataCredentials metadataCredentials) | Sets credentials which used for metadata retrival for agent with specified Id |
| Void SetAgentMetadataDefaultCredentials(String agentId, BaseCredentials defaultCredentials) | Sets the OS login credentials for metadata retrieval for the agent with the specified ID. |
| Void SetAgentMetadataExchangeCredentials(String agentId, BaseCredentials exchangeCredentials) | Sets the Exchange credentials for metadata retrieval for the agent with the specified ID. |
| Void SetAgentMetadataSqlCredentials(String agentId, SqlCredentials sqlCredentials) | Sets the SQL Server credentials for metadata retrieval for the agent with the specified ID. |
| Void SetAgentsMetadataCredentials(AgentMetadataCredentialsCollection agentsMetadataCredentials) | Sets credentials which used for metadata retrival for specified collection of agents |
| Void SetReplicatedAgentRepository(String agentId, String repositoryId) | Assigns a repository to an agent which was added to replication. |
| Void SetScheduleForVolumes(String agentId, VolumeScheduleUpdateRequest volumeScheduleUpdateRequest) | Sets or updates schedule for volumes |
| Void SetStorageConfiguration(String agentId, AgentProtectionStorageConfiguration storageConfiguration) | Restores storage configuration if it was determined for agent |
| Void UpdateAgentCredentialsForEsxServer(AgentDescriptor esxServerHostDescriptor) | Update agent credentials for ESXi server and its virtual machines. |
| Void UpdateAgentCredentialsForHyperVServer(AgentDescriptor hyperVServerHostDescriptor) | Update agent credentials for Hyper-V server and its virtual machines. |
| Void ValidateAgentCreationParameters(AddAgentRequest addAgentRequest) | Validate agent creation parameters. |
| Void ValidateAgentCreationParametersForDeploy(AgentDescriptor esxServerHostDescriptor) | Validate agent creation parameters for deploy. |
| AgentPairingCheckResult ValidateAgentProtectionAbility(AgentDescriptor agentDescriptor) | Verify if the Agent can be protected |
| Void ValidateSelfProtectRestriction(StringCollection agentsIdentifiers) | Validates self protection restriction |
| ValidateMachineResult ValidateVirtualMachine(ValidateMachineRequest request) | Connects to an agent specified in the descriptor (probably not currently protected by this core) and validates virtual machine for pairing. |
| Void VerifyAgentVolumesAreNotInConflictWithRepositoryPaths(AgentVolumeGroupsVerificationRequest verificationRequest) | Verifies whether volumes, selected for protection are not in a conflict state with any of the specified repository paths on agent environment |
| Guid VerifyConnect(String useNtlm, AgentDescriptor agentDescriptor) | Trying to connect to agent and return its Id. |