Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B419
IEventsManagement
This section describes the service operations available for IEventsManagement at events/. The 
IEventsManagement service contract exposes the events and alerts on the Core.
The URI and HTTP method are provided for each service operation.
The service operations include:
•DismissAllAgentAlerts
•DismissAllCoreAlerts
•DismissEvent
•GetAgentAlertsByPage
•GetAgentAlertsCount
•GetAgentAlertsSettings
•GetAgentEventsByPage
•GetAgentEventsCount
•GetAllAgentAlerts
•GetAllAgentEvents
•GetAllCoreAlerts
•GetAllCoreEvents
•GetCachedEventsByDate
•GetConfiguration
•GetCoreAlertsByPage
•GetCoreAlertsCount
•GetCoreEventsByPage
•GetCoreEventsCount
•GetDetailsForEvent
•GetEventsByDate
•GetEventTypes
•SendTestEmail
•SetAgentAlertsSettings
•SetConfiguration
DismissAllAgentAlerts
Gets the summary information for all alerts associated with the specified agent. Note that this list can 
potentially be very large.
URI: events/agents/{agentId}/all
HTTP Method: DELETE
DismissAllCoreAlerts
Marks all alerts for the core as read, thereby dismissing them from the list of alerts.
URI: events/core/all
HTTP Method: DELETE 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B420
DismissEvent
Marks an event as read, thereby dismissing it from the list of events.
URI: events/event/{eventId}
HTTP Method: DELETE
GetAgentAlertsByPage
Gets summary info for alerts for a given agent ID, such that the results are paged for easy viewing in a paged 
grid.
URI: events/agents/{agentId}/alerts/paged?max={max}&page={page}
HTTP Method: GET
GetAgentAlertsCount
Gets non-dismissed alerts count for specified agent.
URI: events/agents/{agentId}/alertsCount
HTTP Method: GET
GetAgentAlertsSettings
Returns the alert settings for the specified agent such as email content and notification settings.
URI: events/config/agents/{agentId}
HTTP Method: GET
GetAgentEventsByPage
Gets summary info for events for a given agent ID, such that the results are paged for easy viewing in a paged 
grid.
URI: events/agents/{agentId}/paged?max={max}&page={page}
HTTP Method: GET
GetAgentEventsCount
Gets events count for specified agent.
URI: events/agents/{agentId}/eventsCount
HTTP Method: GET
GetAllAgentAlerts
Gets the summary information for all alerts associated with the specified agent. Note that this list can 
potentially be very large.
URI: events/agents/{agentId}/alerts/all
HTTP Method: GET
GetAllAgentEvents
Gets the summary information for all events associated with the specified agent. Note that this list can 
potentially be very large.
URI: events/agents/{agentId}/all
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B421
GetAllCoreAlerts
Gets the summary information for all alerts associated with the core. Note that this list can potentially be very 
large.
URI: events/core/alerts/all
HTTP Method: GET
GetAllCoreEvents
Gets the summary information for all events associated with the core. Note that this list can potentially be very 
large.
URI: events/core/all
HTTP Method: GET
GetCachedEventsByDate
Gets the summary information for cached events associated with the specified core ordering by date.
URI: events/cachedEventsDateParam
HTTP Method: PUT
GetConfiguration
Returns configuration information for events such as email content and notification settings.
URI: events/config
HTTP Method: GET
GetCoreAlertsByPage
Gets summary info for events for the core, such that the results are paged for easy viewing in a paged grid.
URI: events/core/alerts/paged?max={max}&page={page}
HTTP Method: GET
GetCoreAlertsCount
Gets non-dismissed alerts count for core.
URI: events/core/alertsCount
HTTP Method: GET
GetCoreEventsByPage
Gets summary info for events for the core, such that the results are paged for easy viewing in a paged grid.
URI: events/core/paged?max={max}&page={page}
HTTP Method: GET
GetCoreEventsCount
Gets events count for core.
URI: events/core/eventsCount
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B422
GetDetailsForEvent
Gets the details for a single event.
URI: events/event/{eventId}
HTTP Method: GET
GetEventsByDate
Gets the summary information for all events associated with the specified core ordering by date.
URI: events/EventsDateRange
HTTP Method: PUT
GetEventTypes
Gets the list of all possible event types, organized into groups.
URI: events/types
HTTP Method: GET
SendTestEmail
Generates and sends a test email notification based on the specified email configuration.
URI: events/config/email/test
HTTP Method: PUT
SetAgentAlertsSettings
Sets alert settings for the specified agent such as email content and notification settings.
URI: events/config/agents/{agentId}
HTTP Method: PUT
SetConfiguration
Sets configuration information for events such as email content and notification settings.
URI: events/config
HTTP Method: PUT
IExchangeManagement
This section describes the service operations available for IExchangeManagement at exchange/. The 
IExchangeManagement service contract exposes the MS Exchange management on the Core.
The URI and HTTP method are provided for each service operation.
The service operations include:
•ForceChecksumCheck
•ForceMountabilityCheck
•GetAgentExchangeServerSettings
•GetChecksumCheckQueueConfiguration
•GetChecksumCheckQueueContents
•GetChecksumCheckQueueEntry 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B423 •GetMountabilityQueueConfiguration
•GetMountabilityQueueContents
•GetMountabilityQueueEntry
•SetAgentExchangeServerSettings
•SetChecksumCheckConfiguration
•SetMountabilityConfiguration
•VerifyCredentials
ForceChecksumCh eck
Forces checksum verification for the specified recovery point.
URI: exchange/checksumcheck/{recoveryPointId}/force
HTTP Method: POST
ForceMountabilityCheck
Forces mountability verification for the specified recovery point.
URI: exchange/mountabilitycheck/{recoveryPointId}/force
HTTP Method: POST
GetAgentExchangeServerSettings
Gets the exchange server settings for the agent.
URI: exchange/agents/{agentId}/exchangeSettings
HTTP Method: GET
GetChecksumCheckQueueConfiguration
Gets the configuration of the checksum check queue.
URI: exchange/checksumcheckconfig
HTTP Method: GET
GetChecksumCheckQueueContents
Gets the contents of the checksum check queue.
URI: exchange/checksumcheckentries
HTTP Method: GET
GetChecksumCheckQueueEntry
Gets the info for a specific checksum check queue entry.
URI: exchange/checksumcheckentries/{entryid}
HTTP Method: GET
GetMountabilityQueueConfiguration
Gets the configuration of the mountability queue.
URI: exchange/mountabilityConfig
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B424
GetMountabilityQueueContents
Gets the contents of the mountability queue.
URI: exchange/mountabilityentries
HTTP Method: GET
GetMountabilityQueueEntry
Gets the info for a specific moutability queue entry.
URI: exchange/mountabilityentries/{entryid}
HTTP Method: GET
SetAgentExchangeServerSettings
Sets the exchange server settings for the agent.
URI: exchange/agents/{agentId}/exchangeSettings
HTTP Method: PUT
SetChecksumCheckConfiguration
Sets the configuration of the checksum check queue.
URI: exchange/checksumcheckconfig
HTTP Method: POST
SetMountabilityConfiguration
Sets the configuration of the mountability queue.
URI: exchange/mountabilityConfig
HTTP Method: POST
VerifyCredentials
Verifies credentials to Exchange instance. Throws exception on validation failure.
URI: exchange/agent/{agentId}/verifyExchangeCredentials
HTTP Method: PUT
IExportQueueManagement
This section describes the service operations available for IExportQueueManagement at export/queue/. The 
IExportQueueManagement service contract is a RESTful API for the export queue.
The URI and HTTP method are provided for each service operation.
The service operations include:
•CancelAllExports
•CancelExports
•GetConfiguration
•GetEntryInfo
•GetQueueContents
•SetConfiguration 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B425
CancelAllExports
Cancels every export in the queue.
URI: export/queue/entries
HTTP Method: DELETE
CancelExports
Cancels the export queue entries identified by the export IDs.
URI: export/queue/entries/cancel
HTTP Method: POST
GetConfiguration
Gets the configuration of the VM export queue.
URI: export/queue/config
HTTP Method: GET
GetEntryInfo
Gets the info for a specific export queue entry.
URI: export/queue/entries/{exportid}
HTTP Method: GET
GetQueueContents
Gets the contents of the export queue.
URI: export/queue/entries
HTTP Method: GET
SetConfiguration
Sets the configuration of the VM export queue.
URI: export/queue/config
HTTP Method: POST
IExportSchedulerManagement
This section describes the service operations available for IExportSchedulerManagement at export/scheduler/. 
The IExportSchedulerManagement service contract is a RESTful API for the export schduler.
The URI and HTTP method are provided for each service operation.
The service operations include:
•DeleteAgentExportConfiguration
•DeleteEC2Credentials
•ForceExport
•GetAgentExportConfiguration
•GetAllAgentsExportConfiguration
•GetAllAgentsExportStatus 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B426 •GetAllAgentsExportStatusWithAdHoc
•GetAllEC2Credentials
•GetEC2Credentials
•GetEc2Environment
•GetFreeSpaceOnNetworkShare
•GetGroupAgentsExportStatus
•GetHyperVCapabilities
•GetVSphereServerInformation
•SetAgentExportConfiguration
•UpdateEC2Credentials
•ValidateEC2Credentials
•Va l i d a t e E x p o r t L o c a t i o n
•ValidateHyperVCredentials
•ValidateHyperVDiskExists
•ValidateHyperVRoleIsInstalled
•ValidateHyperVUefiPartitionByAgentId
•ValidateHyperVUefiPartitionByRecoveryPointId
•ValidateRemoteLinuxMachineCredentials
•ValidateStoragePoolSettings
•ValidateSystemVolumeDiskLocation
•Va l i d a t e V i r t u alBoxInstalled
•Va l i d a t e V i r t u a l B o x U e f i Pa r t i t i o n
•ValidateWindowsMachineCredentials
DeleteAgentExportConfiguration
Deletes the export configuration for the agent.
URI: export/schedule/{agentId}/pgs
HTTP Method: DELETE
DeleteEC2Credentials
Deletes EC2 credential.
URI: export/schedule/ec2/credentials/{key}
HTTP Method: DELETE
ForceExport
Immediately starts VM export of a recovery point which corresponds to specified agent. The recovery point and 
resulting VM type (Workstation, EC2 or ESXi) should be specified in the request instance.
URI: export/schedule/{agentId}/export
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B427
GetAgentExportConfiguration
Gets the export configuration for the agent.
URI: export/schedule/{agentId}/pgs
HTTP Method: GET
GetAllAgentsExportConfiguration
Gets the export configuration for all agents.
URI: export/schedule/agents/allExportConfig
HTTP Method: GET
GetAllAgentsExportStatus
Gets a summary of the export status for every agent on the core for which Virtual Standby is enabled.
URI: export/schedule/agents/all
HTTP Method: GET
GetAllAgentsExportStatusWithAdHoc
Gets a summary of the export status for every agent on the core. Includes AdHoc exports and Virtual Standby 
exports.
URI: export/schedule/agents/alladhoc
HTTP Method: GET
GetAllEC2Credentials
Gets all EC2 credentials.
URI: export/schedule/ec2/credentials
HTTP Method: GET
GetEC2Credentials
Gets specific EC2 credentials.
URI: export/schedule/ec2/credentials/{key}
HTTP Method: GET
GetEc2Environment
Gets EC2 security information specific to an environment whose method is being called.
URI: export/schedule/ec2/environment/{credentialKey}
HTTP Method: GET
GetFreeSpaceOnNetworkShare
Validates a UNC share path.
URI: export/schedule/uncshare/validate
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B428
GetGroupAgentsExportStatus
Gets a summary of the export status for every agent in the given group for which Virtual Standby is enabled.
URI: export/schedule/groups/{groupId}/all
HTTP Method: GET
GetHyperVCapabilities
Gets Hyper-V capabilities.
URI: export/schedule/hyperv/capabilities
HTTP Method: POST
GetVSphereServerInformation
Retrieves the details about a VSphere server for UI functionality.
URI: export/schedule/vsphere/info
HTTP Method: POST
SetAgentExportConfiguration
Sets the export configuration for the agent.
URI: export/schedule/{agentId}/pgs
HTTP Method: PUT
UpdateEC2Credentials
Creates or updates EC2 credential.
URI: export/schedule/ec2/credentials
HTTP Method: POST
ValidateEC2Credentials
Validates an EC2 credential.
URI: export/schedule/ec2/validate
HTTP Method: POST
ValidateExportLocation
Validates location for virtual machine.
URI: export/schedule/vm/location/validate
HTTP Method: POST
ValidateHyperVCredentials
Validates an Hyper-V credentials.
URI: export/schedule/hyperv/credentials
HTTP Method: POST