Dell Appassure 5 User Guide

							Dell AppAssure User Guide
Version 5.4.3 Revision B499
GetAvailableVirtualNetworks
Gets a list of virtual network adapters on Hyper-V server available for a virtual machine.
URI: hypervagent/{virtualMachineId}/availablevirtualnetworks
HTTP Method: GET
GetMaximumProcessorCount
Gets the maximum number of virtual CPUs that could be attached to virtual machine.
URI: hypervagent/cpu/{operatingSystemFamily}
HTTP Method: GET
GetOrCreateVirtualMachineAndAttach
Gets or creates virtual machine specified in request parameter.
URI: hypervagent/getOrCreate
HTTP Method: POST
GetSnapshotsCount
Get the count of snapshots for virtual machine.
URI: hypervagent/{virtualMachineId}/getSnapshotsCount
HTTP Method: GET
GetVirtualDisks
Gets a list of virtual disks currently attached to current virtual machine.
URI: hypervagent/{virtualMachineId}/disks
HTTP Method: GET
GetVirtualMachineName
Gets name of current virtual machine.
URI: hypervagent/{virtualMachineId}/name
HTTP Method: GET
InsertIntegrationServices
Mounts the integration services setup disk.
URI: hypervagent/{virtualMachineId}/integrationservices
HTTP Method: PUT
PingSession
Indicates that session is still being used.
URI: hypervagent/{virtualMachineId}/pingSession
HTTP Method: PUT 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B500
RenameVirtualMachine
Renames current virtual machine.
URI: hypervagent/{virtualMachineId}/newname/{newVirtualMachineName}
HTTP Method: PUT
SetProcessorCount
Changes number of virtual CPUs in current virtual machine.
URI: hypervagent/{virtualMachineId}/cpu/{processorCount}
HTTP Method: PUT
SetRamMegabytes
Changes amount of RAM in current virtual machine.
URI: hypervagent/{virtualMachineId}/ram/{ramValue}
HTTP Method: PUT
Ve r i f y C o n n e c t i o n
Verifies connection to the running HyperV agent.
URI: hypervagent/connect
HTTP Method: GET
IPowerShellManagement
This section describes the service operations available for IPowerShellManagement at powerShell/. 
The IPowerShellManagement interface allows to execute script with parameters from file.
The URI and HTTP method are provided for each service operation is as follows:
•RunPowerShellScriptFromFile
RunPowerShellScriptFromFile
Runs PowerShell script on the agent.
URI: powerShell/
HTTP Method: POST
IRollbackManagement
This section describes the service operations available for IRollbackManagement at rollback/. 
The IRollbackManagement REST service which exposes methods to initiate restoring data from a recovery point 
on an agent.
The URI and HTTP method are provided for each service operation. The service operations include:
•CancelRollback
•DeterminateAutomaticallyAcquiringReplayEngineAddress
•GetRollbackMountDismountStatus
•PartitionDisks 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B501 •StartDismounting
•StartMounting
•StartRollback
CancelRollback
Cancels the running rollback (restore) operation.
URI: rollback/
HTTP Method: DELETE
DeterminateAutomaticallyAcquiringReplayEngineAddress
Determinate if agent can automatically determine acquiring ReplayEngine Address.
URI: rollback/determinateAutomaticallyAcquiringReplayEngineAddress
HTTP Method: GET
GetRollbackMountDismountStatus
Queries the status of the current rollback (restore) operation.
URI: rollback/
HTTP Method: GET
PartitionDisks
Performs automatic disks partitioning basing on partition information in a request object. All existing partitions 
are removed.
URI: rollback/partition
HTTP Method: POST
StartDismounting
Dismount list of databases.
URI: rollback/dismount
HTTP Method: PUT
StartMounting
Mounts a list of databases.
URI: rollback/mount
HTTP Method: PUT
StartRollback
Initiates a rollback (restore) operation on the agent.
URI: rollback/
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B502
IRrcRollbackManagement
This section describes the service operations available for IRrcRollbackManagement at rollback/. 
The IRrcRollbackManagement REST service which exposes methods to initiate rollbacks (restoring data from a 
recovery point) on an agent.
The URI and HTTP method are provided for each service operation is as follows:
•FixBootable
FixBootable
Performs post processing of boot volume in order to correct boot manager and make volume bootable after bare 
metal restore. This method is for internal usage only and should not be called by users.
URI: rollback/fixBoot
HTTP Method: PUT
IServiceHostManagement
This section describes the service operations available for IServiceHostManagement at servicehost/. 
The IServiceHostManagement interface is implemented by a class which provides a management interface to 
the IServiceHost.
The URI and HTTP method are provided for each service operation. The service operations include:
•GetApiVersionInfo
•GetConfiguration
•Restart
•SetConfiguration
•VerifyConnection
GetApiVersionInfo
Obtains the release version information for the API.
URI: servicehost/apiVersion
HTTP Method: GET
GetConfiguration
Gets current configuration of a server that listens for incoming REST calls.
URI: servicehost/config
HTTP Method: GET
Restart
Immediately restarts a server that listens for incoming REST calls.
URI: servicehost/restart
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B503
SetConfiguration
Sets current configuration of a server that listens for incoming REST calls.
URI: servicehost/config
HTTP Method: POST
Ve r i f y C o n n e c t i o n
Allows to verify if listening server is configured properly and able to receive incoming REST calls.
URI: servicehost/verify
HTTP Method: GET
IShadowCopyManagement
This section describes the service operations available for IShadowCopyManagement at shadowcopy/. 
The IShadowCopyManagement service contract exposes some diagnostic information about the Volume Shadow 
Copy service (VSS).
The URI and HTTP method are provided for each service operation is as follows:
•GetWriters
GetWriters
Gets detailed information about Volume Shadow Copy Service (VSS) writers installed on the Agent.
URI: shadowcopy/writers/
HTTP Method: GET
ITransferManagement
This section describes the service operations available for ITransferManagement at transfer/. 
The ITransferManagement is a WCF contract interface that is implemented by a class which in turn, implements 
the management interface on top of the transfer service.
The URI and HTTP method are provided for each service operation. The service operations include:
•DeleteChangeLogsAndMarkClean
•DeleteSnapshot
•FindIncompatibleProducts
•GetDriverMetadata
•GetShadowCopyFile
•GetVolumeAllocatedBlocks
•GetVolumeChangedBlocks
•GetVolumePhysicalDisks
•KeepSessionAlive
•SetDriverMetadata
•SetGlobalVolumeEnablement
•SetVolumeEnablement
•Ta k e S n a p s h o t 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B504
DeleteChangeLogsAndMarkClean
Deletes the Replay change logs for the volume.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/logs
HTTP Method: DELETE
DeleteSnapshot
Deletes the snapshot.
URI: transfer/snapshots/{snapshotSetId}
HTTP Method: POST
FindIncompatibleProducts
Finds and returns the installed incompatible products.
URI: transfer/incompatibleProducts
HTTP Method: POST
GetDriverMetadata
Gets the driver metadata for a volume in the snapshot.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/driver
HTTP Method: GET
GetShadowCopyFile
Gets information about shadow copy files that were created while taking vss snapshot.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/shadowCopyFile
HTTP Method: GET
GetVolumeAllocatedBlocks
Gets a binary representation of the list of allocated blocks on the volume.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/blocks/allocated
HTTP Method: GET
GetVolumeChangedBlocks
Gets a binary representation of the list of changed blocks on the volume.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/blocks/changed
HTTP Method: GET
GetVolumePhysicalDisks
Gets information about the volumes physical layout on physical disk(s).
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/disks
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B505
KeepSessionAlive
Keep the session alive.
URI: transfer/session/retention
HTTP Method: POST
SetDriverMetadata
Sets the driver metadata for a volume in the snapshot. Only sets the metadata values which are not set to their 
default values.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/driver
HTTP Method: POST
SetGlobalVolumeEnablement
Enables or disables a volume. This method works globally since no snapshot ids are needed for it.
URI: transfer/volumes/{volumeName}/enablement
HTTP Method: POST
SetVolumeEnablement
Enables or disables a volume.
URI: transfer/snapshots/{snapshotSetId}/volumes/{volumeName}/enablement
HTTP Method: POST
Ta k e S n a p s h o t
Takes a snapshot of one or more volumes on the agent.
URI: transfer/snapshots
HTTP Method: POST
IVirtualDiskManagement
This section describes the service operations available for IVirtualDiskManagement at vhd/. 
The IVirtualDiskManagement is represented as 
Replay.Common.Contracts.Virtualization.IVirtualDiskManagement.
The URI and HTTP method are provided for each service operation. The service operations include:
•BaseFileName
•BeginBatch
•Close
•Create
•Delete
•EndBatch
•HasSnapshot
•Open
•Read
•ReadCustomMetadata 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B506 •SectorSize
•SnapshotFileName
•Ta k e S n a p s h o t
•TotalSectorCapacity
•TranslateSectorOffsetToChsTuple
•Wr i te
•WriteCustomMetadata
BaseFileName
Gets VHD base file name.
URI: vhd/{id}/baseFileName
HTTP Method: GET
BeginBatch
Begins batch.
URI: vhd/{id}/beginBatch/{target}
HTTP Method: POST
Close
Closes VHD.
URI: vhd/{id}/close
HTTP Method: GET
Create
Creates VHD.
URI: 
vhd/createVhd?path={path}&bytesCapacity={bytesCapacity}&bytesPerSector={bytesPerSector}&containsBootSys
temVolume={containsBootSystemVolume}&preallocate={preallocate}
HTTP Method: PUT
Delete
Deletes VHD snapshot or base file.
URI: vhd/{id}/delete/{target}
HTTP Method: POST
EndBatch
Ends batch.
URI: vhd/{id}/endBatch
HTTP Method: POST 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B507
HasSnapshot
Verifies VHD has snapshot.
URI: vhd/{id}/hasSnapshot
HTTP Method: GET
Open
Opens VHD.
URI: vhd/openVhd?path={path}
HTTP Method: PUT
Read
Reads raw data from VHD.
URI: vhd/{id}/read/{target}/{sectorOffset}/{sectorLength}
HTTP Method: POST
ReadCustomMetadata
Reads a user-defined custom metadata string.
URI: vhd/{id}/readCustomMetadata/{target}/{key}
HTTP Method: POST
SectorSize
Gets sector size of the VHD.
URI: vhd/{id}/sectorSize
HTTP Method: GET
SnapshotFileName
Gets VHD snapshot file name.
URI: vhd/{id}/snapshotFileName
HTTP Method: GET
Ta k e S n a p s h o t
Takes VHD snapshot.
URI: vhd/{id}/takeSnapshot
HTTP Method: GET
TotalSectorCapacity
Gets VHD capacity.
URI: vhd/{id}/totalSectorCapacity
HTTP Method: GET 
						

							Dell AppAssure User Guide
Version 5.4.3 Revision B508
TranslateSectorOffsetToChsTuple
Translates sector offset to chs tuple.
URI: vhd/{id}/translateSectorOffsetToChsTuple?sectorOffset={sectorOffset}
HTTP Method: GET
Write
Writes raw data to VHD.
URI: vhd/{id}/write/{target}/{sectorOffset}/{sectorLength}
HTTP Method: POST
WriteCustomMetadata
Reads a user-defined custom metadata string.
vhd/{id}/writeCustomMetadata/{target}/{key}?value={value}
HTTP Method: POST
IWhiteLabelingManagement
This section describes the service operations available for IWhiteLabelingManagement at whitelabeling/. 
The IWhiteLabelingManagement service contract exposes the customizable strings.
The URI and HTTP method are provided for each service operation is as follows:
•GetWhiteLabelingInfo
GetWhiteLabelingInfo
Gets customizable strings.
URI: whitelabeling/whiteLabelingInfo
HTTP Method: GET