Dell Appassure 5 User Guide

Dell AppAssure User Guide
Version 5.4.3 Revision B
C
359
Extending AppAssure jobs using 
scripting
AppAssure enables administrators to automate the administration and management of resources at certain 
occurrences through the execution of commands and scripts. The AppAssure software supports the use of 
PowerShell scripting for Windows and Bourne Shell scripting for Linux.
Core jobs are automatically created whenever you initiate operations on the AppAssure Core such as 
replication, virtual export, or...

Dell AppAssure User Guide
Version 5.4.3 Revision B360 For more information on how using PowerShell scripts see Sample PowerShell scripts, Input Parameters for 
PowerShell Scripting, Input parameters for Bourne Shell scripting, and Sample Bourne Shell scripts.
Prerequisites for PowerShell scripting
Before running PowerShell scripts for AppAssure, you must have Windows PowerShell 2.0 or later installed. Due 
to new features introduced in PowerShell 3.0, including easier access to object properties,...

Dell AppAssure User Guide
Version 5.4.3 Revision B361
Qualifiers
The following table describes the qualifiers available for AppAssure PowerShell module.
Input Parameters for PowerShell Scripting
All available input parameters are used in sample scripts. The parameters are described in the following tables.
AgentProtectionStorageConfiguration (namespace 
Replay.Common.Contracts.Agents)
The following table presents the available objects for the AgentProtectionStorageConfiguration parameter. Table 206....

Dell AppAssure User Guide
Version 5.4.3 Revision B362
AgentTransferConfiguration (namespace 
Replay.Common.Contracts.Transfer)
The following table presents the available objects for the AgentTransferConfiguration parameter.
Table 208. Objects for the AgentTransferConfiguration parameter
 Method Description
public uint MaxConcurrentStreams { get; set; } Gets or sets the maximum number of concurrent TCP 
connections the Core establishes to the agent for 
transferring data.
public uint MaxTransferQueueDepth...

Dell AppAssure User Guide
Version 5.4.3 Revision B363
BackgroundJobRequest (namespace 
Replay.Core.Contracts.BackgroundJobs)
The following table presents the available objects for the BackgroundJobRequest parameter.
ChecksumCheckJobRequest (namespace 
Replay.Core.Contracts.Exchange.ChecksumChecks)
Inherits its values from the parameter, DatabaseCheckJobRequestBase.
DatabaseCheckJobRequestBase (namespace 
Replay.Core.Contracts.Exchange)
Inherits its values from the parameter, BackgroundJobRequest....

Dell AppAssure User Guide
Version 5.4.3 Revision B364
NightlyAttachabilityJobRequest (namespace 
Replay.Core.Contracts.Sql)
Inherits its values from the parameter, BackgroundJobRequest.
RollupJobRequest (namespace 
Replay.Core.Contracts.Rollup)
Inherits its values from the parameter, BackgroundJobRequest.
TakeSnapshotResponse (namespace 
Replay.Agent.Contracts.Transfer)
The following table presents the available objects for the TakeSnapshotResponse parameter.
TransferJobRequest (namespace...

Dell AppAssure User Guide
Version 5.4.3 Revision B365
TransferPrescriptParameter (namespace 
Replay.Common.Contracts.PowerShellExecution)
The following table presents the available objects for the TransferPrescript parameter.public string Key { get; set; }  Generates a pseudorandom (but not 
cryptographically secure) key, which can be used as a 
one-time password to authenticate transfer requests.
public bool ForceBaseImage { get; set; }  Gets or sets the value indicating whether the base 
image was...

Dell AppAssure User Guide
Version 5.4.3 Revision B366 public AgentTransferConfiguration TransferConfiguration 
{ get; set; } Gets or sets the transfer configuration.
AgentTransferConfiguration is an object which will 
have the following data:
• MaxConcurrentStreams. The maximum 
number of concurrent TCP connections the 
core will establish to the agent for 
transferring data
• MaxTransferQueueDepth. The maximum 
number of block extents which can be 
queued up for writing
• MaxConcurrentWrites. The...

Dell AppAssure User Guide
Version 5.4.3 Revision B367 public AgentTransferConfiguration TransferConfiguration 
{ get; set; } (cont.)• ExcludedWriterIds. Collection of VSS writer 
IDs which should be excluded from this 
snapshot. The writer ID is keyed by the name 
of the writer. This name is for documentation 
purposes only and does not have to exactly 
match the actual name of the writer.
• TransferDataServerPort. A value containing 
the TCP port upon which to accept 
connections from the core for the...

Dell AppAssure User Guide
Version 5.4.3 Revision B368
TransferPostscriptParameter (namespace 
Replay.Common.Contracts.PowerShellExecution)
The following table presents the available objects for the TransferPostscript parameter.
Table 214. Objects for the TransferPostscript parameter
 Method Description
public VolumeNameCollection VolumeNames (get; set; ) Gets or sets the collection of volume names for 
transfer.
VolumeNames is a data structure that contains the 
following data:
• GuidName. The Guid...