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....

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:...

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...

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...

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...

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...

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...

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...

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....

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:...