Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B389
IAgentDiagnosticsManagement
This section describes the service operations available for IAgentDiagnosticsManagement at agentdiag/. The URI 
and HTTP method are provided for each service operation.
The service operations include:
•ExecuteRemoteCommand
•GetLog
•RestartService
•UploadLogSessions IReplicationCommunicationreplicationcomms/ API used internally to communicate between 
cores for replication. 
NOTE: Do not use this API directly.
IReplicationManagementreplication/ API for the configuration, management, and 
monitoring of replication.
IReportingManagementreport/ Interface that is implemented by the core 
reports management service, which provides 
reporting functionality.
IRepositoryManagementreposManagement/ Interface that is implemented by the 
repository management service, which handles 
core operations related to the repositories.
IRollbackManagementrollback/ Interface that is implemented by the core 
rollback service, which provides functionality 
from the Replay engine to restore from a 
recovery point.
IRollupManagementrollup/ Interface implemented by the core rollup 
management service, which provides rollup 
functionality from the Replay engine.
ISeedDriveManagementseedDrive/ Interface that is implemented by the seed 
drive management service, which provides 
copy-consume functionality from the Replay 
engine.
IServiceHostManagementservicehost/ Interface that is implemented by a class which 
provides a management interface to the 
IServiceHost.
ISqlManagementsql/ Interface that is implemented by the core SQL 
management service which provides 
attachability checks and other core-specific 
SQL management functionality
IStatusSummaryManagementstatus/ Exposes summarized status information about 
multiple services in the core that are used for 
displaying status icons in the GUI tabs.
ITransferQueueManagementxfer/queue/ RESTful API for the transfer queue.
ITransferSchedulerManagementxfer/schedule/ RESTful API for the transfer scheduler.
IUtilitiesManagementutilities/ API for a variety of helpers.
IVirtualDiskManagementvhd/ Replay.Common.Contracts.Virtualization.IVirtu
alDiskManagement
IWhiteLabelingManagementwhitelabeling/ Exposes the customizable strings. Table 1. Core service contracts
Service Contract URI Description 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B390
ExecuteRemoteCommand
Runs an arbitrary remote command.
URI: agentdiag/{agentId}/command/
HTTP Method: POST
GetLog
Gets the entire contents of the replay.log file.
URI: agentdiag/{agentId}/log/
HTTP Method: GET
RestartService
Stops, forcibly kills (if necessary), and re-starts the service.
URI: agentdiag/{agentId}/service/
HTTP Method: DELETE
UploadLogSessions
Uploads the current log session to Gibraltar (http://www.gibraltarsoftware.com/).
URI: agentdiag/{agentId}/log/
HTTP Method: POST
IAgentsGroupsManagement
This section describes the service operations available for IAgentsGroupsManagement at agentGroups/. The 
IAgentsGroupsManagement service contract is the interface that is implemented by the groups service, which 
performs actions on the Core related to the group.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddAgent
•AddGroup
•ChangeName
•GetGroups
•RemoveAgent
•RemoveGroup
AddAgent
Adds protected agent to group.
URI: agentGroups/{groupId}/{agentId}
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B391
AddGroup
Adds a new group.
URI: agentGroups/
HTTP Method: POST
ChangeName
Changes name of group.
URI: agentGroups/{groupId}/{newName}
HTTP Method: PUT
GetGroups
Gets a list of all groups known to the core.
URI: agentGroups/
HTTP Method: GET
RemoveAgent
Removes agent from group.
URI: agentGroups/{groupId}/{agentId}
HTTP Method: DELETE
RemoveGroup
Removes group from core.
URI: agentId}agentGroups/{groupId}
HTTP Method: DELETE
IAgentsManagement
This section describes the service operations available for IAgentsManagement at agents/. The 
IAgentsManagement service contract is the interface that is implemented by the agents service, which performs 
actions on the Core related to the agent.
The URI and HTTP method are provided for each service operation.
The service operations include:
•AddAgent
•AddAgents
•AddAgentWithVolumeGroupsValidation
•ChangeAgentDescriptor
•ChangeDisplayName
•ChangeHostName
•ChangePort 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B392 •CheckAgentPairing
•DeleteAgent
•DeleteAgents
•FindAgentById
•ForceAgentMetadataRefresh
•GetAgentDetails
•GetAgentInfo
•GetAgentInfoSummaries
•GetAgentMetadata
•GetAgentMetadataById
•GetAgentMetadataCredentials
•GetAgents
•GetAgentSummaryInfo
•GetAgentSummaryMetadatadata/sum
•GetAgentVolumeGroupsAvailableForProtection
•GetAgentVolumesAvailableForProtection
•GetCachedAgentMetadataById
•GetCachedAgentSummaryMetadataById
•GetPairingSettings
•GetProtectedAgents
•GetProtectedAgentsSummaries
•GetRecoveryPointsOnlyAgents
•GetRecoveryPointsOnlyAgentsSummaries
•GetReplicatedAgents
•GetReplicatedAgentsSummaries
•GetWriters
•IsClusterAddress
•RepairPairing
•SetAgentMetadataCredentials
•SetReplicatedAgentRepository
•ValidateAgentCreationParameters
•ValidateAgentCreationParametersForDeploy
•ValidateAgentProtectionAbility
•VerifyAgentVolumesAreNotInConflictWithRepositoryPaths
•VerifyConnect 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B393
AddAgent
Adds an agent that is not currently protected, pairs with the agent and writes the protection configuration 
information.
URI: agents/new
HTTP Method: POST
AddAgents
Adds the specified agents that are not currently protected. The agents are paired with and their protection 
configuration is written.
URI: agents/newagents
HTTP Method: POST
AddAgentWithVolumeGroupsValidation
Adds an agent that is not currently protected, pairs with the agent and writes the protection configuration 
information and then validates protection groups.
URI: agents/newWithValidGroups
HTTP Method: POST
ChangeAgentDescriptor
Changes the descriptor that is used for an existing agent, allowing the core to use a new caller-specified URI 
and credentials.
URI: agents/{agentId}/descriptor
HTTP Method: POST
ChangeDisplayName
Changes the display name used by the GUI for a given agent.
URI: agents/{agentId}/changeDisplayName/{newDisplayName}
HTTP Method: POST
ChangeHostName
Changes the host name that is used in connecting to a given agent.
URI: agents/{agentId}/changeHostName/{newHostName}
HTTP Method: POST
ChangePort
Changes the port that is used in connecting to a given agent.
URI: agents/{agentId}/port
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B394
CheckAgentPairing
Connects to an agent that is specified in the descriptor (which is probably not currently protected by the core) 
and checks to determine if the agent is paired to the core or any core.
URI: agents/query/checkpairing
HTTP Method: PUT
DeleteAgent
Deletes an agent from the core, optionally deletes the recovery points for the agent and also disables the 
volumes.
URI: agents/{agentId}/delete
HTTP Method: POST
DeleteAgents
Deletes agents from the core, optionally deletes the recovery points for the agent and also disables the 
volumes.
URI: agents/delete
HTTP Method: POST
FindAgentById
Finds the information about a protected agent, if it exists.
URI: agents/find/{agentId}
HTTP Method: GET
ForceAgentMetadataRefresh
Forces a metadata refresh for an agent with a specified ID.
URI: agents/{agentId}/metadata/refresh
HTTP Method: POST
GetAgentDetails
Gets all information that is required to display the Agent Details page in the GUI.
URI: agents/{agentId}/details
HTTP Method: GET
GetAgentInfo
Gets information about the protected agent.
URI: agents/{agentId}/info
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B395
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.
URI: agents/infosummaries
HTTP Method: GET
GetAgentMetadata
Connects to an agent (which is probably not currently being protected by the Core) that is specified in the 
descriptor and requests the metadata for the agent.
URI: agents/query/metadata
HTTP Method: PUT
GetAgentMetadataById
Gets the latest metadata for a protected agent.
URI: agents/{agentId}/metadata
HTTP Method: GET
GetAgentMetadataCredentials
Gets credentials which are used for retrieving the metadata for the agent with a specific ID.
URI: agents/{agentId}/metadata/credentials
HTTP Method: GET
GetAgents
Gets a list of all agents known to the core.
URI: agents/
HTTP Method: GET
GetAgentSummaryInfo
Gets summary agent information including summary metadata, recent associated alerts, and recent recovery 
points.
URI: agents/{agentId}/summaryInfo
HTTP Method: GET
GetAgentSummaryMetadataById
Gets latest summary metadata for an agent that is protected by the Core.
URI: agents/{agentId}/metadata/summary
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B396
GetAgentSummaryMetadatadata/sum
Connects to an agent (which is probably not currently being protected by the Core) that is specified in the 
descriptor and requests the summary metadata for the agent.
URI: agents/query/summarymetadata
HTTP Method: PUT
GetAgentVolumeGroupsAvailableForProtection
Connects to an agent (which is probably not currently being protected by the Core) that is specified in the 
descriptor and requests the list of volumes which are available for protection, and 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.
URI: agents/query/availableGroups
HTTP Method: PUT
GetAgentVolumesAvailableForProtection
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.
URI: agents/query/availablevolumes
HTTP Method: PUT
GetCachedAgentMetadataById
Gets cached metadata for an agent protected by Replay.
URI: agents/{agentId}/cachedmetadata
HTTP Method: GET
GetCachedAgentSummaryMetadataById
Gets cached summary metadata for an agent protected by Replay.
URI: agents/{agentId}/cachedmetadata/summary
HTTP Method: GET
GetPairingSettings
Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests 
the agents pairing information.
URI: agents/query/pairing
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B397
GetProtectedAgents
Gets a list of protected agents known to the core.
URI: agents/protected
HTTP Method: GET
GetProtectedAgentsSummaries
Gets a list of protected agents summaries known to the core.
URI: agents/protectedSummaries
HTTP Method: GET
GetRecoveryPointsOnlyAgents
Gets a list of agent-only recovery points.
URI: agents/recoveryPointsOnly
HTTP Method: GET
GetRecoveryPointsOnlyAgentsSummaries
Gets a summary list of agent-only recover points.
URI: agents/recoveryPointsOnlySummaries
HTTP Method: GET
GetReplicatedAgents
Gets a list of replicated agents known to the core.
URI: agents/replicated
HTTP Method: GET
GetReplicatedAgentsSummaries
Gets a list of replicated agents summaries known to the core.
URI: agents/replicatedSummaries
HTTP Method: GET
GetWriters
Gets detailed information about VSS writers installed on the agent.
URI: agents/{agentId}/writers
HTTP Method: GET
IsClusterAddress
Verify if provided address is cluster.
URI: agents/verifyClusterAddress
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B398
RepairPairing
Attempts to re-establish pairing with an agent already protected by the core, possibly using new credentials.
URI: agents/pairing/repair
HTTP Method: POST
SetAgentMetadataCredentials
Sets credentials which used for metadata retrieval for agent with specified Id.
URI: agents/{agentId}/metadata/credentials
HTTP Method: POST
SetReplicatedAgentRepository
Assigns a repository to an agent which was added to replication.
URI: agents/{agentId}/changeRepository/{repositoryId}
HTTP Method: POST
ValidateAgentCreationParameters
Validate agent creation parameters.
URI: agents/validateAgentCreationParameters
HTTP Method: POST
ValidateAgentCreationParametersForDeploy
Validate agent creation parameters for deploy.
URI: agents/validateAgentCreationParametersForDeploy
HTTP Method: POST
ValidateAgentProtectionAbility
Verify if the Agent can be protected.
URI: agents/validateAgentProtectionAbility
HTTP Method: POST
VerifyAgentVolumesAreNotInConflictWithRepositoryPaths
Verifies whether volumes, selected for protection are not in a conflict state with any of the specified repository 
paths on agent environment.
URI: agents/verifyVolumesConflictState
HTTP Method: POST
Ve r i f y C o n n e c t
Tries to connect to the agent and then return the ID.
URI: agents/verifyConnection/?useNtlm={useNtlm}
HTTP Method: POST