System Center Data Protection Manager 2007 Management Shell Technical Reference

Article
05/17/2011

Applies To: System Center Data Protection Manager 2007

This document contains output from the following command typed in the System Center Data Protection Manager 2007 (DPM) Management Shell:

Get-Command -PSSnapin Microsoft.DataProtectionManager.PowerShell | Sort-Object Noun, Verb | Get-Help -detailed > DPMHelpTopicsSortedNounVerb.txt

This list of cmdlet help topics is sorted by noun groups and contains the same help about each topic that you can view in the DPM implementation of the Windows PowerShell command shell by typing:

Get-Help <Cmdlet-Name> -detailed

Cmdlets Grouped By Noun

Windows PowerShell cmdlets, including DPM cmdlets, are named in the format <Verb>-<Noun>. This command reference groups the cmdlets into sets alphabetized first by noun and then by verb. Select Document Map in the View menu to view a tree of the entire list of cmdlets in the left margin of this document.

BackupNetworkAddress

Add-BackupNetworkAddress

SYNOPSIS

Specifies a backup network for the server to use.

SYNTAX

Add-BackupNetworkAddress [-Address] [-DPMServerName] <String > [-SequenceNumber] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Add-BackupNetworkAddress cmdlet specifies a backup network for the server to use.

PARAMETERS

-Address

The IP address or subnet mask of the network.

-DPMServerName <String>

Name of a DPM server

-SequenceNumber

Specifies the priority of the address for use as backup.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Add-BackupNetworkAddress -DpmServername TestingServer -Address 10.10.10.1/16 -SequenceNumber 1

This command adds the address 10.10.10.1 as the backup network address for the server named TestingServer.

REMARKS

For more information, type: "get-help Add-BackupNetworkAddress -detailed".

For technical information, type: "get-help Add-BackupNetworkAddress -full".

Get-BackupNetworkAddress

SYNOPSIS

Returns a backup network specified for the server.

SYNTAX

Get-BackupNetworkAddress [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-BackupNetworkAddress returns a backup network specified for the server.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-BackupNetworkAddress -DpmServername TestingServer

This command returns the backup network address for the server TestingServer.

REMARKS

For more information, type: "get-help Get-BackupNetworkAddress -detailed".

For technical information, type: "get-help Get-BackupNetworkAddress -full".

Remove-BackupNetworkAddress

SYNOPSIS

Stops the DPM server from trying to use the specified network.

SYNTAX

Remove-BackupNetworkAddress [-DPMServerName] <String> [-Address] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-BackupNetworkAddress cmdlet from using only the specified backup network.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

-Address

The IP address or subnet mask of the network.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Remove- BackupNetworkAddress -DpmServername TestingServer -Address 10.10.10.1/16

This command removes the network address 10.10.10.1 as the backup network address for the server TestingServer.

REMARKS

For more information, type: "get-help Remove-BackupNetworkAddress -detailed".

For technical information, type: "get-help Remove-BackupNetworkAddress -full".

ChildDatasource

Add-ChildDatasource

SYNOPSIS

Adds data source or child data source to a protection group.

SYNTAX

Add-ChildDatasource [-ProtectionGroup] <ProtectionGroup> [-ChildDatasource] <ProtectableObject> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Add-ChildDatasource cmdlet adds data source or child data source to a protection group. A child data source refers to folders on a protected volume.

If you add a data source that was excluded using the Remove-ChildDatasource cmdlet, the exclusion is over-ridden.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-ChildDatasource <ProtectableObject>

A child data source is a part of data source that can be protected individually. For example, a folder in a file system.

-PassThru <SwitchParameter>

The -PassThru parameter can be used with many commands in DPM to return a related object in cases where there is no default output. Using the PassThru parameter allows such cmdlets to be part of a pipeline.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$mpg=Get-ModifiableProtectionGroup $pg[0]

$po = Get-Datasource -ProtectionGroup $pg

Add-ChildDatasource -ProtectionGroup $mpg -ChildDatasource $po[8]

This command adds a child data source to a protection group.

REMARKS

For more information, type: "get-help Add-ChildDatasource -detailed".

For technical information, type: "get-help Add-ChildDatasource -full".

Get-ChildDatasource

SYNOPSIS

Returns the protectable file system objects within a data source.

SYNTAX

Get-ChildDatasource [[-ProtectionGroup] <ProtectionGroup> ] [-ChildDatasource] <ProtectableObject> [-Async] [-Inquire] [-Tag <Object> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ChildDatasource cmdlet return the protectable file system objects such as folders, which are within a data source (file system volume), and can be protected. For file systems alone, we can protect at a child data source level, but for applications they can be protected at the data source level only.

The cmdlet returns both protected and unprotected data sources.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-ChildDatasource <ProtectableObject>

A child data source is a part of data source that can be protected individually. For e.g. a folder in a file system.

-Async

Allows the user to indicate that the cmdlet should run asynchronously. This is useful with cmdlets that take a long time to complete. The control returns to the user immediately after the operation starts. The progress of the operation is communicated to the user periodically. This is useful when building a GUI using cmdlets. It is not used when workingwith the DPM Management Shell.

-Inquire

Queries the protected computer and returns the list of data sources or child data sources on it.

-Tag <Object>

The Tag parameter helps distinguish the replies to each asynchronous call made by a cmdlet. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$ds = Get-Datasource -ProtectionGroup $pg

$cds = Get-ChildDatasource -ChildDatasource $ds[1] -Inquire

This command retrieves the child data sources on a protectable computer.

REMARKS

For more information, type: "get-help Get-ChildDatasource -detailed".

For technical information, type: "get-help Get-ChildDatasource -full".

Remove-ChildDatasource

SYNOPSIS

Removes a data source or child data source from a protection group.

SYNTAX

Remove-ChildDatasource [-ChildDatasource] <ProtectableObject> [-ProtectionGroup] <ProtectionGroup> [-KeepDiskData] [-KeepTapeData] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-ChildDatasource cmdlet removes a data source or child data source from a protection group. A child data source can refer to files, or folders on a protected volume.

PARAMETERS

-ChildDatasource <ProtectableObject>

A child data source is a part of data source that can be protected individually. For e.g. a folder in a file system.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-KeepDiskData

Retain the data on a disk.

-KeepTapeData

Retains the existing data on a tape.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$mpg=Get-ModifiableProtectionGroup $pg[0]

$po = Get-Datasource -ProtectionGroup $pg

Remove-ChildDatasource -ProtectionGroup $mpg -ChildDatasource $po[8]

This command removes the ninth child data source stored in the parent data source.

REMARKS

For more information, type: "get-help Remove-ChildDatasource -detailed".

For technical information, type: "get-help Remove-ChildDatasource -full".

DatasetStatus

Get-DatasetStatus

SYNOPSIS

Returns the dataset state of the archive tape.

SYNTAX

Get-DatasetStatus [-Tape] <Media> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DatasetStatus cmdlet returns the dataset state of the archive tape.

PARAMETERS

-Tape <Media>

Indicates a tape object.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$pt = Get-Tape -ProtectionGroup $pg

Get-DatasetStatus -Tape $pt

This command returns the status of the dataset on the specified tape.

REMARKS

For more information, type: "get-help Get-DatasetStatus -detailed".

For technical information, type: "get-help Get-DatasetStatus -full".

Datasource

Get-Datasource

SYNOPSIS

Retrieves the list of protected and unprotected data in a computer or protection group.

SYNTAX

Get-Datasource [-ProductionServer] <ProductionServer> [-Async] [-Inquire] [-Replica] [-Tag <Object> ] [ <CommonParameters> ]

Get-Datasource [[-ProductionServerName] <String>] [-SearchPath] <String> [-DPMServerName] <String> [ <CommonParameters> ]

Get-Datasource [-DPMServerName] <String> [-Inactive] [ <CommonParameters> ]

Get-Datasource [-ProtectionGroup] <ProtectionGroup> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-Datasource cmdlet retrieves the list of protected and unprotected data on a computer. The output displays only the objects at whose level protection can be done. Use the Get-ChildDatasource cmdlet to see files within the data source.

Using the Inquire parameter returns all the available data sources on the protected computer.

Use the DPMServerName parameter with a search string to search for a protected data source on a DPM server.

Use the Inactive parameter to return all the inactive data sources on a DPM server. An inactive data source is one that is not actively protected on a DPM server.

Use the ProtectionGroup parameter to return the data sources in a protection group.

PARAMETERS

-SearchPath <String>

The path on which to search for the data source.

-ProductionServerName <String>

Name of the server being protected.

-DPMServerName <String>

Name of a DPM server

-ProductionServer <ProductionServer>

A server that has an DPM agent installed on it.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-Async

-Inactive

Using the Inactive parameter returns the inactive data sources on a DPM server. An inactive data source is one which used to be protected at one time, but is not protected currently. The replicas and recovery points of an inactive data source will still be available.

-Inquire

Queries the protected computer and returns the list of data sources or child data sources on it.

-Replica

Indicates that the operation is performed on a replica.

-Tag <Object>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$ps = Get-ProductionServer -DPMServerName TestingServer

Get-Datasource -ProductionServer $ps[1] -Inquire

This command returns the list of all data sources on a computer.

EXAMPLE 2

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-Datasource -ProtectionGroup $pg

This command retrieves the protected data sources in the specified protection group.

EXAMPLE 3

Get-Datasource -DPMServerName "TestingServer" -Inactive

This command retrieves the inactive data sources on a server.

EXAMPLE 4

Get-Datasource -DPMServerName TestingServer -SearchPath "F:\" -ProductionServer "test.contoso.com"

This command retrieves the data source from the specified search location.

REMARKS

For more information, type: "get-help Get-Datasource -detailed".

For technical information, type: "get-help Get-Datasource -full".

DatasourceConsistencyCheck

Start-DatasourceConsistencyCheck

SYNOPSIS

Performs a consistency check on a data source.

SYNTAX

Start-DatasourceConsistencyCheck [-Datasource] <Datasource> [-HeavyWeight] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-ConsistencyCheck performs a consistency check on a data source. By default, DPM performs a light-weight consistency check. Use the -HeavyWeight parameter to perform a heavy-weight consistency check.

PARAMETERS

-Datasource <Datasource>

A Windows file system share or volume, Microsoft SQL database, Microsoft Exchange storage group, Windows SharePoint Services, Microsoft Virtual Machine, Microsoft DPM database, or system state that is a member of a protection group.

-HeavyWeight

Indicates that a heavy weight validation must be performed. This process checksums the contents of each file.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

The JobStateChangedEventHandler is used along with the -Async parameter so that the user can be informed of the status of the operation. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$ds = Get-Datasource -ProtectionGroup $pg

Start-DatasourceConsistencyCheck -Datasource $ds

This command performs a consistency check on the data source.

REMARKS

For more information, type: "get-help Start-DatasourceConsistencyCheck -detailed".

For technical information, type: "get-help Start-DatasourceConsistencyCheck -full".

DatasourceDiskAllocation

Get-DatasourceDiskAllocation

SYNOPSIS

Retrieves the amount of disk space that is allocated to the protected data.

SYNTAX

Get-DatasourceDiskAllocation [-Datasource] <Datasource> [-Async] [-CalculateSize] [-Tag <Object> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DatasourceDiskAllocation cmdlet retrieves the amount of disk space that is allocated to the protected data. This cmdlet returns all the properties of the data source. Use the Get-Member cmdlet to see the properties returned. Refer to PowerShell documentation on how to use the Get-Member cmdlet.

PARAMETERS

-Datasource <Datasource>

-Async

-CalculateSize

Calculates the space allocated on a disk.

-Tag <Object>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$ds = Get-Datasource -ProtectionGroup $pg

Get-DatasourceDiskAllocation -Datasource $ds[1] -CalculateSize

The command returns the amount of disk space allocated to the data source.

REMARKS

For more information, type: "get-help Get-DatasourceDiskAllocation -detailed".

For technical information, type: "get-help Get-DatasourceDiskAllocation -full".

Set-DatasourceDiskAllocation

SYNOPSIS

Modifies disk allocation for the protected data.

SYNTAX

Set-DatasourceDiskAllocation [-Datasource] <Datasource> [-ProtectionGroup] <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-DatasourceDiskAllocation [-ProtectionGroup] <ProtectionGroup> -CustomRequirements [-Datasource] <Datasource> [-FormatVolumes <Nullable`1> ] [-PassThru <SwitchParameter> ] [-ReplicaVolume <DpmServerVolume> ] [-ShadowCopyVolume <DpmServerVolume> ] [-USNJournalSize <Int64> ] [ <CommonParameters> ]

Set-DatasourceDiskAllocation [-ProtectionGroup] <ProtectionGroup> [-Datasource] <Datasource> -Manual [-PassThru <SwitchParameter> ] [-ProductionServerJournalSize <Int64> ] [-ReplicaArea <Int64> ] [-ShadowCopyArea <Int64> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-DatasourceDiskAllocation cmdlet modifies disk allocation for the protected data.

Using the -Manual parameter you can specify the amount of disk space to allot to each data source in a protection group. Using the -CustomRequirements parameter you can specify the volumes to use for each data source in a protection group. If you use neither parameter, DPM will assign the default disk space and volumes for the data source.

PARAMETERS

-Datasource <Datasource>

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-CustomRequirements

Allows you to specify replica and shadow copy volumes manually.

-Manual

Indicates that the settings will be made manually.

-FormatVolumes <Nullable`1>

Indicates whether the allocated volumes should be formatted.

-PassThru <SwitchParameter>

-ProductionServerJournalSize <Int64>

The journal size of the protected server.

-ReplicaArea <Int64>

Sets the disk allocation for the replica area for the current data source.

-ReplicaVolume <DpmServerVolume>

A replica volume is a volume on the DPM server that contains the replica of a protected data source.

-ShadowCopyArea <Int64>

Sets the disk allocation for the shadow copy area for the current data source.

-ShadowCopyVolume <DpmServerVolume>

The volume on which the shadow copy is present.

-USNJournalSize <Int64>

The USN journal size.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$mpg = Get-ModifiableProtectionGroup $pg

$ds = Get-Datasource -ProtectionGroup $mpg

Get-DatasourceDiskAllocation -Datasource $ds[1]

Set-DatasourceDiskAllocation -Datasource $ds[1] -ProtectionGroup $mpg

Set-ProtectionGroup $mpg

This command sets the disk allocation the second data source in the data source list $ds.

REMARKS

For more information, type: "get-help Set-DatasourceDiskAllocation -detailed".

For technical information, type: "get-help Set-DatasourceDiskAllocation -full".

DatasourceProtectionOption

Get-DatasourceProtectionOption

SYNOPSIS

Returns the protection options for all data sources of the specified data source type in a protection group.

SYNTAX

Get-DatasourceProtectionOption [-ProtectionGroup] <ProtectionGroup> -FileSystem [ <CommonParameters> ]

Get-DatasourceProtectionOption [-ProtectionGroup] <ProtectionGroup> -ExchangeOptions [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DatasourceProtectionOption cmdlet returns the protection options for all data sources of the specified datasource type in a protection group.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-ExchangeOptions

Indicates that the options that follow affect only Microsoft Exchange data sources.

-FileSystem

Indicates operation is done on a file system datasource

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

REMARKS

For more information, type: "get-help Get-DatasourceProtectionOption -detailed".

For technical information, type: "get-help Get-DatasourceProtectionOption -full".

Set-DatasourceProtectionOption

SYNOPSIS

Sets the protection options for the specified datasource.

SYNTAX

Set-DatasourceProtectionOption [-FileType] <String> -ProtectionGroup <ProtectionGroup> -Remove [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-DatasourceProtectionOption [-FileType] <String> -Add -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-DatasourceProtectionOption [[-TopologyType] <ProtectionTopologyType> ] [ [-PreferredPhysicalNode] <String> ] -ExchangeOptions -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [-RunEseUtilConsistencyCheck] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-DatasourceProtectionOption cmdlet sets the protection options for the specified datasource.

Using the -Remove parameter allows you to exclude all files of a particular type from protection. For e.g., all mp3 files.

Using the -Add parameter allows you to remove any exclusions set using the -Remove parameter.

Using the -ExchangeOptions parameter allows you to set the protection options for an Exchange data source.

PARAMETERS

-FileType <String>

Indicates the file type to include or exclude in a protection.

-PreferredPhysicalNode <String>

Applies to Microsoft Exchange 2007 cluster continuous replication alone. In case Preferred Server topology is selected, then the server to be protected must be specified.

-TopologyType <ProtectionTopologyType>

Applies to Microsoft Exchange Server 2007 cluster continuous replication only. The available topologies are Active, Passive, Active if Passive Not Available.

-Add

Adds a file exclusion on a protection group.

-ExchangeOptions

Indicates that the options that follow affect only Microsoft Exchange data sources.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-Remove

Indicates that a remove operation will be performed.

-PassThru <SwitchParameter>

-RunEseUtilConsistencyCheck

Indicates that the EseUtil consistency check should be run. This is applicable only for Microsoft Exchange data sources.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

REMARKS

For more information, type: "get-help Set-DatasourceProtectionOption -detailed".

For technical information, type: "get-help Set-DatasourceProtectionOption -full".

DatasourceReplica

Remove-DatasourceReplica

SYNOPSIS

Removes an inactive replica

SYNTAX

Remove-DatasourceReplica -Datasource <Datasource> [-Disk] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Remove-DatasourceReplica -Datasource <Datasource> -Tape <Media> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-DatasourceReplica cmdlet removes an inactive replica. You can indicate whether the replica is on disk or tape by using the -Disk or -Tape parameters.

PARAMETERS

-Datasource <Datasource>

-Tape <Media>

Indicates a tape object.

-Disk

Indicates that the operation must be performed on a disk.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName "TestingServer"

$ds = Get-Datasource -ProtectionGroup $pg

Remove-DatasourceReplica -Datasource $ds -Disk

This command removes a replica of the data source from disk.

REMARKS

For more information, type: "get-help Remove-DatasourceReplica -detailed".

For technical information, type: "get-help Remove-DatasourceReplica -full".

DPMDisk

Add-DPMDisk

SYNOPSIS

Adds a new disk to the storage pool

SYNTAX

Add-DPMDisk [-DPMDisk] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Add-DPMDisk cmdlet adds a new disk to the storage pool.

PARAMETERS

-DPMDisk

A disk that is part of a storage pool.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMDisk = Get-DPMDisk -DPMServerName TestingServer

Add-DPMDisk -DPMDisk $DPMDisk

This command adds the disk object in $DPMDisk to the server.

REMARKS

For more information, type: "get-help Add-DPMDisk -detailed".

For technical information, type: "get-help Add-DPMDisk -full".

Get-DPMDisk

SYNOPSIS

Returns a list of disks found in the last rescan on a DPM server.

SYNTAX

Get-DPMDisk [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DPMDisk cmdlet returns a list of disks found in the last rescan on a DPM server.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-DPMDisk -DPMServerName "TestingServer"

This command returns the list of disks on the server TestingServer.

REMARKS

For more information, type: "get-help Get-DPMDisk -detailed".

For technical information, type: "get-help Get-DPMDisk -full".

Remove-DPMDisk

SYNOPSIS

Removes a disk from the storage pool.

SYNTAX

Remove-DPMDisk [-DPMDisk] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-DPMDisk cmdlet removes a disk from the storage pool.

PARAMETERS

-DPMDisk

A disk that is part of a storage pool.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMDisk = Get-DPMDisk -DPMServerName TestingServer

Remove-DPMDisk -DPMDisk $DPMDisk

This command removes the disk object in $DPMDisk from the server.

REMARKS

For more information, type: "get-help Remove-DPMDisk -detailed".

For technical information, type: "get-help Remove-DPMDisk -full".

DPMDiskRescan

Start-DPMDiskRescan

SYNOPSIS

Scans for new disks or disks where congifuration has changed.

SYNTAX

Start-DPMDiskRescan [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-DPMDiskRescan scans for new disks or disks where congifuration has changed on the DPM server.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Start-DPMDiskRescan -DPMServerName "TestingServer"

This command scans the specified DPM server for new disks or disks where configuration has changed.

REMARKS

For more information, type: "get-help Start-DPMDiskRescan -detailed".

For technical information, type: "get-help Start-DPMDiskRescan -full".

DPMLibrary

Disable-DPMLibrary

SYNOPSIS

Disables the specified library.

SYNTAX

Disable-DPMLibrary [-DPMLibrary] <Library> [-Confirm] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Disable-DPMLibrary cmdlet disables the specified library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Confirm

Asks the user to confirm the action.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Disable-DPMLibrary -DPMLibrary $DPMLib

This command disables the library on the TestingServer.

REMARKS

For more information, type: "get-help Disable-DPMLibrary -detailed".

For technical information, type: "get-help Disable-DPMLibrary -full".

Enable-DPMLibrary

SYNOPSIS

Enables the specified library.

SYNTAX

Enable-DPMLibrary [-DPMLibrary] <Library> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Enable-DPMLibrary cmdlet enables the specified library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Enable-DPMLibrary -DPMLibrary $DPMLib

This command enables the library on the server TestingServer.

REMARKS

For more information, type: "get-help Enable-DPMLibrary -detailed".

For technical information, type: "get-help Enable-DPMLibrary -full".

Get-DPMLibrary

SYNOPSIS

Returns the list of libraries attached to the DPM server and their status.

SYNTAX

Get-DPMLibrary [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DPMLibrary cmdlet returns the list of libraries attached to the DPM server and their status.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-DPMLibrary -DPMServerName "TestingServer"

This command returns the list of libraries attached to the specified DPM server and their status.

REMARKS

For more information, type: "get-help Get-DPMLibrary -detailed".

For technical information, type: "get-help Get-DPMLibrary -full".

Rename-DPMLibrary

SYNOPSIS

Renames the specified library.

SYNTAX

Rename-DPMLibrary [-NewName] <String> [-DPMLibrary] <Library> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Rename-DPMLibrary cmdlet renames the specified library.

PARAMETERS

-NewName <String>

The new name for an object.

-DPMLibrary <Library>

A DPM library object.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Rename-DPMLibrary -DPMLibrary $DPMLib -NewName "LibNewName"

This command renames the library on the server TestingServer.

REMARKS

For more information, type: "get-help Rename-DPMLibrary -detailed".

For technical information, type: "get-help Rename-DPMLibrary -full".

DPMLibraryDoor

Lock-DPMLibraryDoor

SYNOPSIS

Locks the door of the specified library.

SYNTAX

Lock-DPMLibraryDoor [-DPMLibrary] <Library> [-Async] [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Lock-DPMLibraryDoor cmdlet locks the door of the specified library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Async

-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler>

This is the call-back method for an Async door operation. If the user calls the cmdlet with the –Async flag then he can provide a static or member method name of a class to act as the handler for the progress event of the long running door operation. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Lock-DPMLibraryDoor -DPMLibrary $DPMLib[0]

This command locks the library door of the specified library.

REMARKS

For more information, type: "get-help Lock-DPMLibraryDoor -detailed".

For technical information, type: "get-help Lock-DPMLibraryDoor -full".

Unlock-DPMLibraryDoor

SYNOPSIS

Unlocks the door of the specified library.

SYNTAX

Unlock-DPMLibraryDoor [-DPMLibrary] <Library> [[-Timeout] <Int32> ] [-Async] [-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Unlock-DPMLibraryDoor cmdlet unlocks the door of the specified library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Timeout <Int32>

Indicates after how long time out should occur.

-Async

-DoorAccessJobStateChangeEventHandler <DoorAccessJobStateChangeEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Unlock-DPMLibraryDoor -DPMLibrary $DPMLib

REMARKS

For more information, type: "get-help Unlock-DPMLibraryDoor -detailed".

For technical information, type: "get-help Unlock-DPMLibraryDoor -full".

DPMLibraryIEPort

Lock-DPMLibraryIEPort

SYNOPSIS

Locks and loads the media present in the IE port.

SYNTAX

Lock-DPMLibraryIEPort [-DPMLibrary] <Library> [-Async] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Lock-DPMLibraryIEPort cmdlet locks and loads the media present in the IE port into the slot.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Async

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Lock-DPMLibraryDoor -DPMLibrary $DPMLib

REMARKS

For more information, type: "get-help Lock-DPMLibraryIEPort -detailed".

For technical information, type: "get-help Lock-DPMLibraryIEPort -full".

Unlock-DPMLibraryIEPort

SYNOPSIS

Unlocks the IE port for the specified library.

SYNTAX

Unlock-DPMLibraryIEPort [-DPMLibrary] <Library> [-Async] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Unlock-DPMLibraryIEPort unlocks the IE port for the specified library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Async

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Unlock-DPMLibraryDoor -DPMLibrary $DPMLib

REMARKS

For more information, type: "get-help Unlock-DPMLibraryIEPort -detailed".

For technical information, type: "get-help Unlock-DPMLibraryIEPort -full".

DPMLibraryInventory

Start-DPMLibraryInventory

SYNOPSIS

Starts an inventory of the tape in the specified library.

SYNTAX

Start-DPMLibraryInventory [-DPMLibrary <Library> ] [-FastInventory] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

Start-DPMLibraryInventory -DetailedInventory [-DPMLibrary <Library> ] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-Tape <Media> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-DPMLibraryInventory cmdlet starts an inventory of the tape in the specified library.

You must specify the FastInventory parameter if you do not want detailed inventory to be performed.

PARAMETERS

-DetailedInventory

Indicates that a detailed inventory must be performed on the specified library. A detailed inventory will mount and read the header of the tape.

-DPMLibrary <Library>

A DPM library object.

-FastInventory

Indicates that a fast inventory must be performed on the specified library. A fast inventory will not read the headers from the tape.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

-Tape <Media>

Indicates a tape object.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Start-DPMLibraryInventory -DPMLibrary $DPMLib -FastInventory

This command performs a fast inventory of the library on the TestingServer.

EXAMPLE 2

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Start-DPMLibraryInventory -DPMLibrary $DPMLib -DetailedInventory

This command performs a detailed inventory of the library on TestingServer.

REMARKS

For more information, type: "get-help Start-DPMLibraryInventory -detailed".

For technical information, type: "get-help Start-DPMLibraryInventory -full".

DPMLibraryRescan

Start-DPMLibraryRescan

SYNOPSIS

Starts a rescan job in the background to identify new libraries or ones that have changed.

SYNTAX

Start-DPMLibraryRescan [-DPMServerName] <String> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-DPMLibraryRescan cmdlet starts a scan to identify new libraries or ones that have been changed.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Start-DPMLibraryRescan -DPMServerName TestingServer

This command starts a rescan of the libraries on TestingServer.

REMARKS

For more information, type: "get-help Start-DPMLibraryRescan -detailed".

For technical information, type: "get-help Start-DPMLibraryRescan -full".

DPMServer

Connect-DPMServer

SYNOPSIS

Opens a connection to a DPM server.

SYNTAX

Connect-DPMServer [-DPMServerName] <String> [-AsyncOperation <AsyncOperation> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Connect-Server cmdlet opens a connection to a DPM server. By default, DPM looks for the server in the current domain. To connect to a server in another domain, you must specify the domain name.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

-AsyncOperation <AsyncOperation>

Used for synchronization purposes.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Connect-DPMServer TestingServer.corporate.contoso.com

This command connects to TestingServer in the contoso domain.

REMARKS

For more information, type: "get-help Connect-DPMServer -detailed".

For technical information, type: "get-help Connect-DPMServer -full".

Disconnect-DPMServer

SYNOPSIS

Closes and releases all objects for a DPM connection session.

SYNTAX

Disconnect-DPMServer [[-DPMServerName] <String> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Disconnect-Server closes and releases all objects for a DPM connection session.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Disconnect-DPMServer -DPMServerName "TestingServer"

This command closes all connections to TestingServer.

REMARKS

For more information, type: "get-help Disconnect-DPMServer -detailed".

For technical information, type: "get-help Disconnect-DPMServer -full".

DPMTapeData

Copy-DPMTapeData

SYNOPSIS

Copies the data from a tape for a given recovery point.

SYNTAX

Copy-DPMTapeData [-RecoveryPoint] <RecoverySource> -SourceLibrary <Library> -TapeLabel <String> -TapeOption <TapeOptions> -TargetLibrary <Library> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-RecoveryPointLocation <RecoverySourceLocation> ] [-Restore] [ <CommonParameters> ]

Copy-DPMTapeData -DPMServerName <String> -IncompleteDataset <HeadlessDataset> -OverwriteType <OverwriteType> -Tape <Media> -TargetPath <String> -TargetServer <String> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-RecoveryNotification <Notification> ] [-RecreateReparsePoint] [-Restore] [-RestoreSecurity] [ <CommonParameters> ]

Copy-DPMTapeData [-RecoveryPoint] <RecoverySource> -OverwriteType <OverwriteType> -Tape <Media> -TargetPath <String> -TargetServer <String> [-JobStateChangedEventHandler <JobStateChangedEventHandler>] [-RecoveryNotification <Notification> ] [-RecoveryPointLocation <RecoverySourceLocation> ] [-RecreateReparsePoint] [-Restore] [-RestoreSecurity] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Copy-DPMTapeData cmdlet copies the data from a tape for a given recovery point.

PARAMETERS

-RecoveryPoint <RecoverySource>

The recovery point to use.

-DPMServerName <String>

Name of a DPM server

-IncompleteDataset <HeadlessDataset>

Indicates that in the case of data that spans multiple tapes, the operation will be carried out only on the part of the data present on the current tape.

-OverwriteType <OverwriteType>

Indicates the action to be taken when the file being recovered already exists. The possible values are - CreateCopy, Skip, Overwrite.

-SourceLibrary <Library>

Indicates the location from where the dataset has to be copied.

-Tape <Media>

Indicates a tape object.

-TapeLabel <String>

The label to identify the tape.

-TapeOption <TapeOptions>

Indicates where compression or encryption or neither should be performed to the data on the tape. The possible values are 0, 1 or 2 for Compress, Encrypt and NoCompressAndNoEncrypt respectively.

-TargetLibrary <Library>

Indicates the target library to which the dataset should be copied.

-TargetPath <String>

The path to the target.

-TargetServer <String>

The server to which recovery is made.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

-RecoveryNotification <Notification>

Notifies you when recovery has been completed. The notification object is returned by the New-NotificationObject cmdlet.

-RecoveryPointLocation <RecoverySourceLocation>

The location of the recovery point. This is necessary if a recovery item exists in more than one location for the same point in time. For e.g. on a disk and tape, or on two tapes.

-RecreateReparsePoint

Indicates if the reparse point has to be recreated.

-Restore

Indicates a restore operation.

-RestoreSecurity

Indicates the security settings to use during a restore operation. This is a switch parameter. When you use the -RestoreSecurity parameter in the cmdlet, it indicates that the security settings from the recovery point will be used. If the -RestoreSecurity parameter is not used, it indicates that the security settings of the destination server will be used.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

REMARKS

For more information, type: "get-help Copy-DPMTapeData -detailed".

For technical information, type: "get-help Copy-DPMTapeData -full".

Test-DPMTapeData

SYNOPSIS

Verifies the data set for a recovery point.

SYNTAX

Test-DPMTapeData [-RecoveryPoint] <RecoverySource> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-RecoveryPointLocation <RecoverySourceLocation> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Test-DPMTapeData cmdlet verifies the data set for a recovery point.

PARAMETERS

-RecoveryPoint <RecoverySource>

The recovery point to use.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

-RecoveryPointLocation <RecoverySourceLocation>

The location of the recovery point. This is necessary if a recovery item exists in more than one location for the same point in time. For e.g. on a disk and tape, or on two tapes.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

$rp = Get-RecoveryPoint -Datasource $ds

$rsl = Get-RecoveryPointLocation -RecoveryPoint $rp[1]

Test-DPMTapeData -RecoveryPoint $rp[1] -RecoveryPointLocation $rsl

This command verifies the recovery point at the specified location.

REMARKS

For more information, type: "get-help Test-DPMTapeData -detailed".

For technical information, type: "get-help Test-DPMTapeData -full".

DPMVolume

Get-DPMVolume

SYNOPSIS

Returns a list of volumes on the DPM server.

SYNTAX

Get-DPMVolume [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-DPMVolume cmdlet returns a list of volumes on the DPM server.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-DPMVolume -DPMServerName "TestingServer"

This command returns the volumes on TestingServer.

REMARKS

For more information, type: "get-help Get-DPMVolume -detailed".

For technical information, type: "get-help Get-DPMVolume -full".

HeadlessDataset

Get-HeadlessDataset

SYNOPSIS

Returns any incomplete dataset on the archive tape.

SYNTAX

Get-HeadlessDataset [-Tape] <Media> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-HeadlessDataset cmdlet returns the incomplete dataset (if any) lying on the archive tape.

PARAMETERS

-Tape <Media>

Indicates a tape object.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$Tape = Get-Tape -DPMLibrary $DPMLib

Get-HeadlessDataset -Tape $Tape[2]

This command returns the incomplete data on the tape.

REMARKS

For more information, type: "get-help Get-HeadlessDataset -detailed".

For technical information, type: "get-help Get-HeadlessDataset -full".

MaintenanceJobStartTime

Get-MaintenanceJobStartTime

SYNOPSIS

Returns the start time of the maintenance job.

SYNTAX

Get-MaintenanceJobStartTime [-DPMServerName] <String> [-MaintenanceJob] <HouseKeepingJobs> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-MaintenanceJobStartTime returns the start time of the maintanence job.

Returns when Catalog Pruning or Detailed Inventory jobs are reschedule to run.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

-MaintenanceJob <HouseKeepingJobs>

Indicates a maintenance job to be performed on the replica. The valid values are CatalogPruning and DetailedInventory.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-MaintenanceJobStartTime -DPMServerName TestServer -MaintenanceJob CatalogPruning

This command returns the time when catalog pruning is scheduled to run on the server.

REMARKS

For more information, type: "get-help Get-MaintenanceJobStartTime -detailed".

For technical information, type: "get-help Get-MaintenanceJobStartTime -full".

Set-MaintenanceJobStartTime

SYNOPSIS

Sets or removes the start time of a maintenance job.

SYNTAX

Set-MaintenanceJobStartTime -DPMServerName <String> -MaintenanceJob <HouseKeepingJobs> [-Remove] [ <CommonParameters> ]

Set-MaintenanceJobStartTime [[-StartTime] <DateTime> ] -DPMServerName <String> -MaintenanceJob <HouseKeepingJobs> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-MaintenanceJobStartTime cmdlet sets the start time of a maintenance job.

Use the -Remove parameter to stop running the job.

Catalog Pruning and Detailed Inventory jobs can be rescheduled using this cmdlet.

PARAMETERS

-StartTime <DateTime>

Indicates a time when an operation must begin.

-DPMServerName <String>

Name of a DPM server

-MaintenanceJob <HouseKeepingJobs>

Indicates a maintenance job to be performed on the replica. The valid values are CatalogPruning and DetailedInventory.

-Remove

Indicates that a remove operation will be performed.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Set-MaintenanceJobStartTime -DPMServerName TestServer -MaintenanceJob CatalogPruning -StartTime 02:00

This command sets the maintenance job to run on the server at 2 a.m.

EXAMPLE 2

Set-MaintenanceJobStartTime -DPMServerName TestServer -MaintenanceJob LibraryInventory -Remove

This command stops the running of the automatic inventory.

REMARKS

For more information, type: "get-help Set-MaintenanceJobStartTime -detailed".

For technical information, type: "get-help Set-MaintenanceJobStartTime -full".

ModifiableProtectionGroup

Get-ModifiableProtectionGroup

SYNOPSIS

Retrieves a protection group in an editable mode.

SYNTAX

Get-ModifiableProtectionGroup [-ProtectionGroup] <ProtectionGroup> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ModifiableProtectionGroup cmdlet retrieves a protection group in an editable mode since the protection group object returned by Get-ProtectionGroup is not editable. Once you have carried out the changes to the protection group, you must save the changes using the Set-ProtectionGroup cmdlet. The sequence of steps when working with a modifiable protection group are

Get-ProtectionGroup

Get-ModifiableProtectionGroup

Set-ProtectionGroup

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-ModifiableProtectionGroup -ProtectionGroup $pg

This command returns the protection group in a modifiable state.

REMARKS

For more information, type: "get-help Get-ModifiableProtectionGroup -detailed".

For technical information, type: "get-help Get-ModifiableProtectionGroup -full".

OnlineRecatalog

Start-OnlineRecatalog

SYNOPSIS

Returns a detailed list of data on a tape.

SYNTAX

Start-OnlineRecatalog [-RecoveryPoint] <RecoverySource> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-RecoveryPointLocation <RecoverySourceLocation> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-OnlineRecatalog cmdlet returns a detailed list of data on a tape. This is required to perform partial recoveries or recovery of selected files.

PARAMETERS

-RecoveryPoint <RecoverySource>

The recovery point to use.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

-RecoveryPointLocation <RecoverySourceLocation>

The location of the recovery point. This is necessary if a recovery item exists in more than one location for the same point in time. For e.g. on a disk and tape, or on two tapes.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

$rp = Get-RecoveryPoint -Datasource $ds

$rsl = Get-RecoveryPointLocation -RecoveryPoint $rp

Start-OnlineRecatalog -RecoveryPoint $rp[1] -RecoveryPointLocation $rsl

This command performs on online catalog of the recovery point on TestingServer.

REMARKS

For more information, type: "get-help Start-OnlineRecatalog -detailed".

For technical information, type: "get-help Start-OnlineRecatalog -full".

PerformanceOptimization

Set-PerformanceOptimization

SYNOPSIS

Enables setting or removing of on-wire compression of data.

SYNTAX

Set-PerformanceOptimization [-ProtectionGroup] <ProtectionGroup> -DisableCompression [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-PerformanceOptimization [-ProtectionGroup] <ProtectionGroup> -EnableCompression [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-PerformanceOptimization cmdlet enables setting or removing on-wire compression on a protection group.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-DisableCompression

Indicates that on-wire compression of data must be disabled.

-EnableCompression

Indicates that throttling must be enabled.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg = Get-ModifiableProtectionGroup -ProtectionGroup $pg

Set-PerformanceOptimization -ProtectionGroup $mpg -EnableCompression

This command enables on-wire compression of data for all data sources being protected in the given PG

REMARKS

For more information, type: "get-help Set-PerformanceOptimization -detailed".

For technical information, type: "get-help Set-PerformanceOptimization -full".

PolicyObjective

Get-PolicyObjective

SYNOPSIS

Returns the protection policy for a protection group.

SYNTAX

Get-PolicyObjective [-ProtectionGroup] <ProtectionGroup> -ShortTerm <Nullable`1> [ <CommonParameters> ]

Get-PolicyObjective [-ProtectionGroup] <ProtectionGroup> -LongTerm [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-PolicyObjective cmdlet returns the protection policy for a protection group. The cmdlet returns the retention range and protection frequency (synchronization to disk or backup to tape) of the protection group.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-LongTerm

Indicates that the protection group is set to long-term tape protection.

-ShortTerm <Nullable`1>

Indicates that the protection group will be on disk, tape or none, if nothing is specified.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-PolicyObjective -ProtectionGroup $pg -ShortTerm

Returns the short-term policy objective of the protection group.

$pg holds a protection group.

EXAMPLE 2

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-PolicyObjective -ProtectionGroup $pg -LongTerm

Returns the long-term policy objective of a protection group.

$pg holds a protection group.

REMARKS

For more information, type: "get-help Get-PolicyObjective -detailed".

For technical information, type: "get-help Get-PolicyObjective -full".

Set-PolicyObjective

SYNOPSIS

Sets the policy objective for a protection group.

SYNTAX

Set-PolicyObjective [-RetentionRangeInDays] <Int32> [[-SynchronizationFrequency] <Int32> ] -ProtectionGroup <ProtectionGroup> [-BeforeRecoveryPoint] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-PolicyObjective [-RetentionRangeList] <RetentionRange> [-FrequencyList] <Int32> [-GenerationList] <GenerationType> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-PolicyObjective [-RetentionRangeInWeeks] <Int32> [-ShortTermBackupFrequency] <BackupFrequency> -ProtectionGroup <ProtectionGroup> [-CreateIncrementals] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-PolicyObjective [-RetentionRange] <RetentionRange> [-LongTermBackupFrequency] <BackupFrequency> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-PolicyObjective cmdlet sets the policy objective for a protection group. You can set the policy to disk or tape. You can also specofy the retention range for the protection group.

Default schedules are set automatically when you specify the protection objective using Set-PolicyObjective. To modify the default schedules use a Get-PolicySchedule followed by Set-PolicySchedule.

PARAMETERS

-RetentionRangeInWeeks <Int32>

The number of weeks for which a replica will be retained.

-RetentionRangeInDays <Int32>

The number of days for which a replica will be retained.

-RetentionRange <RetentionRange>

Duration of time for which data will be retained on tape for long-term protection.

-FrequencyList <Int32>

The list of backup frequencies defined in the three protection objectives.

-RetentionRangeList <RetentionRange>

The list of retention periods defined in the three protection objectives.

-SynchronizationFrequency <Int32>

The number of times synchronization should take place.

-LongTermBackupFrequency <BackupFrequency>

The backup frequency for long-term protection. The possible values are Daily, Weekly, BiWeekly, Monthly, Quarterly, HalfYearly, and Yearly.

-ShortTermBackupFrequency <BackupFrequency>

The backup frequency for short-term protection.

-GenerationList <GenerationType>

The list of generations (father, grandfather and great grandfather) defined in the three protection objectives.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-BeforeRecoveryPoint

Indicates that synchronisation should occur before creation of recovery point.

-CreateIncrementals

Indicates whether incremental backups should be created.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg=Get-ModifiableProtectionGroup $pg[0]

Set-PolicyObjective $mpg -RetentionRangeInDays 10 -SynchronizationFrequency360

This command sets the policy objective for the protection to a retention range of 10 days and synchronization frequency of 6 hours.

EXAMPLE 2

$rr= new-object -TypeName Microsoft.Internal.EnterpriseStorage.Dls.UI.ObjectModel.OMCommon.RetentionRange -ArgumentList 1,"months"

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg=Get-ModifiableProtectionGroup $pg[0]

Set-PolicyObjective -RetentionRange 360 -LongTermBackupFrequency Weekly $mpg

This command sets the retention range for Testing Server to 360 days with a weekly backup frequency.

EXAMPLE 3

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg=Get-ModifiableProtectionGroup $pg[0]

Set-PolicyObjective -RetentionRangeInWeeks 12 -ShortTermBackupFrequency Daily $mpg

This command sets the retention range for Testing Server to 12 weeks with a daily backup frequency.

REMARKS

For more information, type: "get-help Set-PolicyObjective -detailed".

For technical information, type: "get-help Set-PolicyObjective -full".

PolicySchedule

Get-PolicySchedule

SYNOPSIS

Returns the schedule for various protection jobs like synchronization, recovery point creation (shadow copy), and tape backups.

SYNTAX

Get-PolicySchedule [-ProtectionGroup] <ProtectionGroup> -ShortTerm <Nullable`1> [ <CommonParameters> ]

Get-PolicySchedule [-ProtectionGroup] <ProtectionGroup> -OffsetSchedule [ <CommonParameters> ]

Get-PolicySchedule [-ProtectionGroup] <ProtectionGroup> -LongTerm [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-PolicySchedule cmdlet returns the schedule for various protection jobs like synchronization, recovery point creation (shadow copy), and tape backups.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-LongTerm

Indicates that the protection group is set to long-term tape protection.

-OffsetSchedule

The minute intervals by which the synchronization will be offset. It can range between 0 and 14 minutes. This helps reduce the load on the DPM server.

-ShortTerm <Nullable`1>

Indicates that the protection group will be on disk, tape or none, if nothing is specified.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-PolicySchedule -ProtectionGroup $pg -ShortTerm

This command returns the short-term synchronisation schedule of the protection group.

EXAMPLE 2

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-PolicySchedule -ProtectionGroup $pg -LongTerm

This command returns the long-term synchronization schedule of the protection group.

REMARKS

For more information, type: "get-help Get-PolicySchedule -detailed".

For technical information, type: "get-help Get-PolicySchedule -full".

Set-PolicySchedule

SYNOPSIS

Sets the schedule for various protection jobs like synchronization, recovery point creation (shadow copy), and tape backups.

SYNTAX

Set-PolicySchedule [-Schedule] <Schedule> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-PolicySchedule [-OffsetInMinutes] <Int32> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-PolicySchedule cmdlet sets the schedule for various protection jobs like synchronization, recovery point creation (shadow copy), and tape backups.

Default schedules are set automatically when you specify the protection objective using Set-PolicyObjective. To modify the default schedules use a Get-PolicySchedule followed by Set-PolicySchedule.

The various schedules that can be set are:

For Express full & SC schedule

[-TimesOfDay] <TimesOfDay> [-DaysOfWeek]<DaysOfWeek>

Ex: 6:00 AM, 12:00 AM We,Th

For Monthly/HalfYearly/Yearly ArchiveSchedules

[-StartTime] <StartTime> [-RelativeInterval <RelativeInterval>] [-DayOfWeek <DayOfWeek>]

Ex: -StartTime 1/1/2003 6:00 AM -RelativeInterval First -DayOfWeek Sa

For Daily Archive schedule

[-TimeOfDay] <TimeOfDay>

Ex: -StartTime 6:00 AM

For Quarterly Archive schedule

[-StartTime] <StartTime> -StartTime 1/1/2003 6:00 AM

The frequency is determined by the input schedule.

PARAMETERS

-Schedule <Schedule>

A schedule describes the recurrence of the backup job. There is one schedule per job type which DPM triggers. Default schedules are generated by Set-PolicyObjective cmdlet. To customize the schedule, use Get-PolicySchedule and pass the schedule to Set-PolicySchedule specifying the backup recurrence.

-OffsetInMinutes <Int32>

The time in minutes by which you want to offset the start time of a job.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ShadowCopysch = Get-PolicySchedule $pg -ShortTerm

Set-PolicySchedule $pg $ShadowCopysch -DaysOfWeek mo -TimesOfDay 02:00

Sets the synchronization schedule for a protection group to be carried out on every Monday at 2 a.m.

REMARKS

For more information, type: "get-help Set-PolicySchedule -detailed".

For technical information, type: "get-help Set-PolicySchedule -full".

ProductionCluster

Get-ProductionCluster

SYNOPSIS

Returns a list of all clusters on which the DPM agent is installed.

SYNTAX

Get-ProductionCluster [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ProductionCluster cmdlet returns a list of all clusters on which the DPM agent is installed.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-ProductionCluster -DPMServerName "TestingServer"

This command returns a list of clusters protected by TestingServer.

REMARKS

For more information, type: "get-help Get-ProductionCluster -detailed".

For technical information, type: "get-help Get-ProductionCluster -full".

ProductionServer

Get-ProductionServer

SYNOPSIS

Returns the list of servers that have the DPM Protection Agent installed on them.

SYNTAX

Get-ProductionServer [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ProductionServer returns the list of servers that have the DPM Protection Agent installed on them.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-ProductionServer -DPMServerName "TestingServer"

This command returns the list of computers that have the Protection Agent installed on them and protected by the server TestingServer.

REMARKS

For more information, type: "get-help Get-ProductionServer -detailed".

For technical information, type: "get-help Get-ProductionServer -full".

ProductionServerSwitchProtection

Start-ProductionServerSwitchProtection

SYNOPSIS

Switches protection of a data source between the primary DPM server and the disaster recovery server.

SYNTAX

Start-ProductionServerSwitchProtection [-Password] <SecureString> [-ProtectionType] <ProtectionType> [-UserName] <String> [-DomainName] <String> [-ProductionServer] <ProductionServer> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-ProductionServerSwitchProtection cmdlet is used to switch protection of a data source between the primary DPM server and the (Secondary DPM Server) disaster recovery server. This cmdlet is used in two scenarios:

A) The primary DPM server crashes and you want to continue protection of your data sources. In this scenario, the cmdlet is executed on the secondary DPM server to directly protect data sources on the protected server using the Secondary DPM server.

B) The primary server is restored and can resume protecting the data source again. In this scenario, the cmdlet needs to be executed twice. Once on the primary DPM server, to switch protection of the data source and begin to directly protect it. Next on the Secondary DPM server, to restore protection of the primary DPM server.

The valid values for ProtectionType are protectfromps and protectfromdpm.

PARAMETERS

-Password <SecureString>

Password for the user account. Do not pass this value through the command line. Run the command and wait to be prompted for the password.

-ProtectionType <ProtectionType>

Indicates the type of protection.

-UserName <String>

The user account to use.

-DomainName <String>

The domain to which the user account belongs.

-ProductionServer <ProductionServer>

A server that has an DPM agent installed on it.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

REMARKS

For more information, type: "get-help Start-ProductionServerSwitchProtection -detailed".

For technical information, type: "get-help Start-ProductionServerSwitchProtection -full".

ProductionVirtualName

Get-ProductionVirtualName

SYNOPSIS

Returns the virtual names for a cluster.

SYNTAX

Get-ProductionVirtualName [-ProductionCluster] <Cluster> [-Async] [-Handler <EventHandler'1> ] [-Tag <Object> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ProductionVirtualName cmdlet returns the virtual names for a cluster.

PARAMETERS

-ProductionCluster <Cluster>

A cluster of protectable servers.

-Async

-Handler <EventHandler'1>

Is called when an event is received. This is useful when building a GUI using cmdlets. It is not used when working with the DPM Management Shell.

-Tag <Object>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pc = Get-ProductionCluster -DPMServerName "TestingServer"

Get-ProductionVirtualName -ProductionCluster $pc

This command returns the virtual name of the clusters protected by TestingServer.

REMARKS

For more information, type: "get-help Get-ProductionVirtualName -detailed".

For technical information, type: "get-help Get-ProductionVirtualName -full".

ProtectionGroup

Get-ProtectionGroup

SYNOPSIS

Retrieves the list of protection groups on the DPM server.

SYNTAX

Get-ProtectionGroup [-DPMServerName] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ProtectionGroup cmdlet retrieves the list of protection groups on the DPM server.

The protection group, however, is not in a modifiable mode. To make the protection group modifiable you must follow-up the Get-ProtectionGroup with the Get-ModifiableProtectionGroup cmdlet.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

Get-ProtectionGroup -DPMServerName TestingServer

This command returns the protection group on a DPM server.

REMARKS

For more information, type: "get-help Get-ProtectionGroup -detailed".

For technical information, type: "get-help Get-ProtectionGroup -full".

New-ProtectionGroup

SYNOPSIS

Creates a new protection group on the DPM server.

SYNTAX

New-ProtectionGroup [-DPMServerName] <String> [[-Name] <String> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The New-ProtectionGroup cmdlet creates a new protection group on the specified DPM server. This is the first step towards creating a new protection group. This cmdlet returns a new protection group object on which you can perform the remaining steps required for creating a protection group. However, the protection group is not actually created until you run the Set-ProtectionGroup cmdlet.

PARAMETERS

-DPMServerName <String>

Name of a DPM server

-Name <String>

Name of a protection group

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

New-ProtectionGroup -DPMServerName "TestingServer" -Name "Trial PG"

This command creates an instance of a protection group named TrialPG in the memory of TestingServer. This is the first step in the creation of the protection group.

REMARKS

For more information, type: "get-help New-ProtectionGroup -detailed".

For technical information, type: "get-help New-ProtectionGroup -full".

Rename-ProtectionGroup

SYNOPSIS

Renames an existing protection group on the DPM server.

SYNTAX

Rename-ProtectionGroup [-ProtectionGroup] <ProtectionGroup> [-NewName] <String> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Rename-ProtectionGroup cmdlet renames an existing protection group with a new name. The process of renaming a protection group involves the following steps –

1. Retrieve the protection group using the Get-ProtectionGroup cmdlet.

2. Make the protection group modifiable using the Get-ModifiableProtectionGroup cmdlet.

3. Rename the protection group using the Rename-ProtectionGroup cmdlet.

4. Save the changes using the Set-ProtectionGroup cmdlet.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-NewName <String>

The new name for an object.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup - DPMServerName 'TestingServer'

$mpg = Get-ModifiableProtectionGroup $pg

Rename-ProtectionGroup -ProtectionGroup $mpg -NewName 'ModifiedPG'

Set-ProtectionGroup $mpg

This command renames the protection group Trial PG to Modified PG.

REMARKS

For more information, type: "get-help Rename-ProtectionGroup -detailed".

For technical information, type: "get-help Rename-ProtectionGroup -full".

Set-ProtectionGroup

SYNOPSIS

Saves all the actions performed on the protection group on the DPM server.

SYNTAX

Set-ProtectionGroup [-ProtectionGroup] <ProtectionGroup> [-Async] [-TranslateDSList <Datasource> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-ProtectionGroup cmdlet saves all the actions performed on the protection group on the DPM server.

For example, when a new protection group is being created this cmdlet is the final step in the process.

Until the Set-ProtectionGroup cmdlet is executed, the actions taken on a modifiable protection group or a new protection group only exist only in the memory.

The sequence of steps when working with a modifiable protection group are

Get-ProtectionGroup

Get-ModifiableProtectionGroup

Set-ProtectionGroup

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-Async

-TranslateDSList <Datasource>

A list of data sources that need to be force translated. This helps in regenerating jobs.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Set-ProtectionGroup -ProtectionGroup $pg

This command saves the protection group. This is the final step in creating a protection group.

REMARKS

For more information, type: "get-help Set-ProtectionGroup -detailed".

For technical information, type: "get-help Set-ProtectionGroup -full".

ProtectionJobStartTime

Get-ProtectionJobStartTime

SYNOPSIS

Returns the start time of a protection job.

SYNTAX

Get-ProtectionJobStartTime [-ProtectionGroup] <ProtectionGroup> [-JobType] [ <JobTypeType ProtectionJobType> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ProtectionJobStartTime cmdlet returns the start time of a protection job.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-JobType [<JobTypeType ProtectionJobType>]

Indicates the type of job for which options are being set. The possible value that this parameter can take is ConsistencyCheck.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-ProtectionJobStartTime -ProtectionGroup $pg -JobType ConsistencyCheck

This command returns the job start time for the consistency check on the protection group.

REMARKS

For more information, type: "get-help Get-ProtectionJobStartTime -detailed".

For technical information, type: "get-help Get-ProtectionJobStartTime -full".

Set-ProtectionJobStartTime

SYNOPSIS

Sets or changes the start time of a protection job.

SYNTAX

Set-ProtectionJobStartTime [-ProtectionGroup] <ProtectionGroup> -JobType [ <JobTypeType ProtectionJobType> ] -Remove [ <CommonParameters> ]

Set-ProtectionJobStartTime [-StartTime] <DateTime> [-MaximumDurationInHours] <Int32> -JobType [ <JobTypeType ProtectionJobType> ] [-ProtectionGroup] <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-ProtectionJobStartTime cmdlet sets or changes the start time of a protection job, currently only consistency check.

Use the -Remove parameter to stop a protection job.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-StartTime <DateTime>

Indicates a time when an operation must begin.

-MaximumDurationInHours <Int32>

The maximum number of hours that a job should run.

-JobType [<JobTypeType ProtectionJobType>]

Indicates the type of job for which options are being set. The possible value that this parameter can take is ConsistencyCheck.

-Remove

Indicates that a remove operation will be performed.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg = Get-ModifiableProtectionGroup -ProtectionGroup $pg

Set-ProtectionJobStartTime -ProtectionGroup $mpg -JobType ConsistencyCheck -StartTime 02:00

Set-ProtectionGroup $mpg

This command schedules for a consistency check to run on the protection group at 2 a.m. everyday.

REMARKS

For more information, type: "get-help Set-ProtectionJobStartTime -detailed".

For technical information, type: "get-help Set-ProtectionJobStartTime -full".

ProtectionType

Set-ProtectionType

SYNOPSIS

Allows you to specify the protection type to be used with the protection group.

SYNTAX

Set-ProtectionType [-ProtectionGroup] <ProtectionGroup> [-LongTerm] [-PassThru <SwitchParameter> ] [-ShortTerm <Nullable`1> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-ProtectionType cmdlet allows you to specify the protection type to be used with the protection group.

The ShortTerm and LongTerm parameters can be used individually or in a combination to define the various protection types.

The various combinations are:

-ShortTerm Disk: Disk to Disk

-ShortTerm Tape: Disk to Tape

-LongTerm: Disk to Tape (long-term)

-ShortTerm Disk -LongTerm: Disk to Disk to Tape

-ShortTerm Tape -LongTerm: Disk to Tape to Tape

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-LongTerm

Indicates that the protection group is set to long-term tape protection.

-PassThru <SwitchParameter>

-ShortTerm <Nullable`1>

Indicates that the protection group will be on disk, tape or none, if nothing is specified.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = New-ProtectionGroup -DPMServerName TestingServer

Set-ProtectionType -ProtectionGroup $pg -ShortTerm disk

This command sets the protection type for the protection group to short-term on disk.

EXAMPLE 2

$pg = New-ProtectionGroup -DPMServerName TestingServer

Set-ProtectionType -ProtectionGroup $pg -ShortTerm disk -LongTerm

This command sets the protection type for the protection group to disk to disk to tape.

REMARKS

For more information, type: "get-help Set-ProtectionType -detailed".

For technical information, type: "get-help Set-ProtectionType -full".

RecoverableItem

Get-RecoverableItem

SYNOPSIS

Returns a list of recoverable items in a recovery point.

SYNTAX

Get-RecoverableItem [-Datasource] <Datasource> [-SearchOption] <SearchSpecifications> [-Async] [-Tag <Object> ] [ <CommonParameters> ]

Get-RecoverableItem [-RecoveryPoint] <RecoverySource> [-Async] [-Tag <Object> ] [ <CommonParameters> ]

Get-RecoverableItem [-BrowseType] <BrowseType> [-RecoverableItem] <RecoverableObject> [-Async] [-Tag <Object> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-RecoverableItem cmdlet returns a list of recoverable items in a recovery point.

The recoverable items based on source are:

File system: Files and folders

Microsoft Exchange: Storage groups, databases and mailboxes

Microsoft SQL: Databases

Microsoft ShapePoint: Sites, databases and documents

Virtual Machines

A DPM server

System state of a protected computer

PARAMETERS

-SearchOption <SearchSpecifications>

Sets the search options as defined in New-SearchOption.

-BrowseType <BrowseType>

Indicates whether to browse only the parent nodes or go down to the child nodes. The valid values are Parent and Child.

-Datasource <Datasource>

-RecoverableItem <RecoverableObject>

A child item within a recovery point that can be recovered. For e.g. a Windows file system share or volume, Microsoft SQL database, Microsoft Exchange storage group, Windows SharePoint Services, Microsoft Virtual Machine, Microsoft DPM database, system state or a recovery point.

-RecoveryPoint <RecoverySource>

The recovery point to use.

-Async

-Tag <Object>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

$rp = Get-RecoveryPoint -Datasource $ds

Get-RecoverableItem -RecoverableItem $rp -BrowseType child

This command returns an object that can be recovered from the recovery point.

REMARKS

For more information, type: "get-help Get-RecoverableItem -detailed".

For technical information, type: "get-help Get-RecoverableItem -full".

RecoverableItem

Recover-RecoverableItem

SYNOPSIS

Recovers a version of the data source to a target location.

SYNTAX

Recover-RecoverableItem [-RecoverableItem] <RecoverableObject> [-RecoveryOption] <RecoveryOption> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [-RecoveryNotification <Notification> ] [-RecoveryPointLocation <RecoverySourceLocation> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Recover-RecoverableItem cmdlet recovers a point in time version of a data source (recovery point) or a child recoverable item within it to the target location.

PARAMETERS

-RecoverableItem <RecoverableObject>

-RecoveryOption <RecoveryOption>

Encapsulates the user's protection intent while performing a recovery based on the recovery source and recovery type. This object is built using the New-RecoveryOption cmdlet.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

-RecoveryNotification <Notification>

Notifies you when recovery has been completed. The notification object is returned by the New-NotificationObject cmdlet.

-RecoveryPointLocation <RecoverySourceLocation>

The location of the recovery point. This is necessary if a recovery item exists in more than one location for the same point in time. For e.g. on a disk and tape, or on two tapes.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$rp = Get-RecoveryPoint -Datasource $ds

$rop = New-RecoveryOption -TargetServer test.contoso.com -RecoveryLocation copytofolder -FileSystem -AlternateLocation "f:\restore" -OverwriteType overwrite -RestoreSecurity -RecoveryType Restore

Recover-RecoverableItem -RecoverableItem $rp -RecoveryOption $rop

This command recovers the entire recovery point specified.

REMARKS

For more information, type: "get-help Recover-RecoverableItem -detailed".

For technical information, type: "get-help Recover-RecoverableItem -full".

RecoveryNotification

New-RecoveryNotification

SYNOPSIS

Builds the notification object used for recovery.

SYNTAX

New-RecoveryNotification [-NotificationType] <NotificationType> [-NotificationIdList] <String> [ <CommonParameters> ]

DETAILED DESCRIPTION

The New-RecoveryNotification cmdlet builds the notification object used for recovery.

PARAMETERS

-NotificationType <NotificationType>

Indicates the type of notification. Currently DPM supports only e-mail notifications.

-NotificationIdList <String>

The list of ids to which notifications must be sent out. Currently DPM supports on e-mail notifications.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

New-RecoveryNotification -NotificationType email -NotificationIdList mailme@mytestingdomain.com.

This command creates a new e-mail notification for an event.

REMARKS

For more information, type: "get-help New-RecoveryNotification -detailed".

For technical information, type: "get-help New-RecoveryNotification -full".

RecoveryOption

New-RecoveryOption

SYNOPSIS

Allows setting of recovery options for various servers.

SYNTAX

New-RecoveryOption -PrimaryDpmServer -RecoverToReplicaFromTape [-DPMLibrary <Library> ] [-RecoveryLocation <RecoveryLocation> ] [-SANRecovery] [-TargetServer <String> ] [ <CommonParameters> ]

New-RecoveryOption -FileSystem -OverwriteType <OverwriteType> -RecoverToReplicaFromTape -RecoveryType <RecoveryType> [-AlternateLocation <String> ] [-DPMLibrary <Library> ] [-RecoveryLocation <RecoveryLocation> ] [-RestoreSecurity] [-SANRecovery] [-TargetServer <String> ] [ <CommonParameters> ]

New-RecoveryOption -DatabaseFileTempLocation <String> -ExportFileTempLocation <String> -IntermediateSharepointServer <String> -IntermediateSqlInstance <String> -RecoverToReplicaFromTape -RecoveryType <RecoveryType> -SharePointSite [-DPMLibrary <Library> ] [-RecoveryLocation <RecoveryLocation> ] [-RestoreSecurity] [-SANRecovery] [-TargetLocation <String> ] [-TargetServer <String> ] [-TargetSiteUrl <String>] [ <CommonParameters> ]

New-RecoveryOption -GenericDatasource -RecoverToReplicaFromTape -RecoveryType <RecoveryType> [-DPMLibrary <Library> ] [-RecoveryLocation <RecoveryLocation> ] [-RestoreSecurity] [-SANRecovery] [-TargetLocation <String> ] [-TargetServer <String> ] [ <CommonParameters> ]

New-RecoveryOption -RecoverToReplicaFromTape -RecoveryType <RecoveryType> -SQL [-AlternateDatabaseDetails <AlternateDatabaseDetailsType> ] [-CopyLogFiles] [-DPMLibrary <Library> ] [-LeaveDBInRestoringState] [-LogFileCopyLocation <String> ] [-RecoveryLocation <RecoveryLocation> ] [-RestoreSecurity] [-RollForwardRecovery] [-SANRecovery] [-TargetLocation <String> ] [-TargetServer <String> ] [ <CommonParameters> ]

New-RecoveryOption -Exchange -ExchangeOperationType <ExchangeOperationType> -RecoveryType <RecoveryType> [-AlternateDatabase <String> ] [-AlternateStorageGroup <String> ] [-DatabaseName <String> ] [-IsRecoveryStorageGroup] [-MailboxDisplayName <String> ] [-MountDatabaseAfterRestore] [-RestoreSecurity] [-RollForwardRecovery] [-SANRecovery] [-StorageGroupName <String> ] [-TargetLocation <String> ] [ <CommonParameters> ]

New-RecoveryOption -RecoverToReplicaFromTape -RecoveryType <RecoveryType> -SharePoint [-DPMLibrary <Library> ] [-RecoveryLocation <RecoveryLocation> ] [-RestoreSecurity] [-SANRecovery] [-TargetLocation <String> ] [-TargetServer <String> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The New-RecoveryOption cmdlet allows setting of recovery options for file servers, Exchange, Windows Sharepoint Services servers, Windows SharePoint Services sites, SQL servers and other data sources.

PARAMETERS

-DatabaseFileTempLocation <String>

Temporary location for a database file.

-Exchange

Indicates that the current operation is being performed on an Microsoft Exchange data source.

-ExchangeOperationType <ExchangeOperationType>

Indicates the type of operation to be carried out. The valid values are NoOperation, MailBoxLevelRecovery, and NeedCleanShutdown.

-ExportFileTempLocation <String>

Location of the export file

-FileSystem

Indicates operation is done on a file system datasource

-GenericDatasource

Indicates that the current operation is being performed on a data source like Microsoft Virtual Server.

-IntermediateSharepointServer <String>

A Windows Sharepoint Services server used during Microsoft Windows Services site recovery. It should have a Windows Sharepoint Services farm installed.

-IntermediateSqlInstance <String>

A SQL server used during Windows Sharepoint Services site recovery. It is used to temporarily host a SQL database.

-OverwriteType <OverwriteType>

Indicates the action to be taken when the file being recovered already exists. The possible values are - CreateCopy, Skip, Overwrite.

-PrimaryDpmServer

Indicates that the recovery is to a DPM server.

-RecoverToReplicaFromTape

Indicates that recovery to the replica must happen from a tape.

-RecoveryType <RecoveryType>

Indicates that the recovery type is Recover or Restore.

-SharePoint

Indicates that the current operation is being performed on a Windows Sharepoint Services data source.

-SharePointSite

Indicates that the operation is being carried out on a Windows SharePoint Services site.

-SQL

Indicates that the current operation is being performed on an Microsoft SQL data source.

-AlternateDatabase <String>

Name of an alternate database.

-AlternateDatabaseDetails <AlternateDatabaseDetailsType>

The type of database.

-AlternateLocation <String>

Name of an alternate location to which a recovery point must be made.

-AlternateStorageGroup <String>

Name of an alternate storage group for a new recovery point.

-CopyLogFiles

Indicates that the log files have to be copied.

-DatabaseName <String>

Name of a database

-DPMLibrary <Library>

A DPM library object.

-IsRecoveryStorageGroup

Indicates if the recovery is a recovery storage group.

-LeaveDBInRestoringState

This is a switch parameter. If you do not use the parameter it indicates that the database should be left non-operational but in a restorable state. If you use the parameter it indicates that the database should be left operational

-LogFileCopyLocation <String>

Location to which the log files must be copied.

-MailboxDisplayName <String>

The name to be displayed on the mailbox.

-MountDatabaseAfterRestore

Indicates that the database should be automatically mounted after restore.

-RecoveryLocation <RecoveryLocation>

Indicates to what location the recovery is being done. The valid values are OriginalServer, CopyToFolder, OriginalServerWithDBRename, AlternateExchangeServer, and ExchangeServerDatabase.

-RestoreSecurity

-RollForwardRecovery

Indicates that the application should be recovered from the latest recovery point and all logs after that recovery point should be applied to bring the application to the latest state.

-SANRecovery

-StorageGroupName <String>

Name of a storage group.

-TargetLocation <String>

The location where the replica has to be stored.

-TargetServer <String>

The server to which recovery is made.

-TargetSiteUrl <String>

The URL to which recovery is made.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

New-RecoveryOption -TargetServer test.contoso.com -RecoveryLocation copytofolder -FileSystem -AlternateLocation "f:\restore" -OverwriteType overwrite -RestoreSecurity -RecoveryType Restore

This command recovers the file system to test.domain.com and restores the original security settings.

REMARKS

For more information, type: "get-help New-RecoveryOption -detailed".

For technical information, type: "get-help New-RecoveryOption -full".

RecoveryPoint

Get-RecoveryPoint

SYNOPSIS

Returns all available recovery points for a data source.

SYNTAX

Get-RecoveryPoint [-Datasource] <Datasource> [-Async] [ <CommonParameters> ]

Get-RecoveryPoint [-Tape] <Media> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-RecoveryPoint cmdlet returns all available recovery points for a data source.

PARAMETERS

-Tape <Media>

Indicates a tape object.

-Datasource <Datasource>

A Windows file system share or volume, Microsoft SQL database, Microsoft Exchange storage group, Windows SharePoint Services, Microsoft Virtual Machine, DPM database, or system state that is a member of a protection group.

-Async

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

Get-RecoveryPoint -Datasource $ds

This command returns the recovery point for the data source.

REMARKS

For more information, type: "get-help Get-RecoveryPoint -detailed".

For technical information, type: "get-help Get-RecoveryPoint -full".

New-RecoveryPoint

SYNOPSIS

Creates a new recovery point for the data source.

SYNTAX

New-RecoveryPoint -Datasource <Datasource> -Disk [-BackupType <BackupType> ] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

New-RecoveryPoint -Datasource <Datasource> -ProtectionType <ProtectionType> -Tape <Media> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

New-RecoveryPoint -Datasource <Datasource> -Disk -DiskRecoveryPointOption <CreateDiskRecoveryPointOption> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The New-RecoveryPoint cmdlets creates a new recovery point for the data source.

The valid values for ProtectionType are ShortTerm and LongTerm.

PARAMETERS

-Datasource <Datasource>

-Disk

Indicates that the operation must be performed on a disk.

-DiskRecoveryPointOption <CreateDiskRecoveryPointOption>

Indicates whether recovery point should be created while synchronizing or whether only synchronization should occur. The valid values are WithSynchronize, WithoutSynchronize and OnlySynchronize.

-ProtectionType <ProtectionType>

Indicates the type of protection.

-Tape <Media>

Indicates a tape object.

-BackupType <BackupType>

Indicates the type of backup. The valid values are ExpressFull and Incremental.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

New-RecoveryPoint -Datasource $ds -Disk -BackupType expressfull

This command runs an Expressfull backup and creates a recovery point.

EXAMPLE 2

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

New-RecoveryPoint -Datasource $ds -Disk -DiskRecoveryPointOption withsynchronize

This command synchronizes and then creates a new recovery point for the data source on disk.

EXAMPLE 3

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

New-RecoveryPoint -Datasource $ds -Tape -ProtectionType ShortTerm

This command creates a new recovery point for the data source on a tape with type set to short-term.

REMARKS

For more information, type: "get-help New-RecoveryPoint -detailed".

For technical information, type: "get-help New-RecoveryPoint -full".

Remove-RecoveryPoint

SYNOPSIS

Removes a recovery point from tape or disk.

SYNTAX

Remove-RecoveryPoint [-RecoveryPoint] <RecoverySource> [-Confirm] [-ForceDeletion] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-RecoveryPoint removes a recovery point from tape or disk.

If a recovery point exists in multiple location, for e.g. on disk and tape, or two tapes, then use the Get-RecoveryPointLocation to get the location of the recovery point.

PARAMETERS

-RecoveryPoint <RecoverySource>

The recovery point to use.

-Confirm

Asks the user to confirm the action.

-ForceDeletion

Indicates that deletion will occur without user confirmation.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

$rp = Get-RecoveryPoint -Datasource $ds

Remove-RecoveryPoint -RecoveryPoint $rp

This command removes all the recovery points for a data source.

REMARKS

For more information, type: "get-help Remove-RecoveryPoint -detailed".

For technical information, type: "get-help Remove-RecoveryPoint -full".

RecoveryPointLocation

Get-RecoveryPointLocation

SYNOPSIS

Returns the location of a recovery point.

SYNTAX

Get-RecoveryPointLocation [-RecoveryPoint] <RecoverySource> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-RecoveryPointLocation cmdlet returns the location of a recovery point. The returned object indicates whether the recovery point is located on disk or tape. In case it is on a tape, the cmdlet will return the tape's details.

PARAMETERS

-RecoveryPoint <RecoverySource>

The recovery point to use.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$ds = Get-Datasource -ProtectionGroup $pg

$rp = Get-RecoveryPoint -Datasource $ds

Get-RecoveryPointLocation -RecoveryPoint $rp

This command returns the location of the specified recovery point.

REMARKS

For more information, type: "get-help Get-RecoveryPointLocation -detailed".

For technical information, type: "get-help Get-RecoveryPointLocation -full".

ReplicaCreationMethod

Get-ReplicaCreationMethod

SYNOPSIS

Retrieves the replica creation method that is specified for a protection group.

SYNTAX

Get-ReplicaCreationMethod [-ProtectionGroup] <ProtectionGroup> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-ReplicaCreationMethod cmdlet retrieves the replica creation method that is specified for a protection group. The replica creation method specifies when the creation of a replica is initiated. The possible values are Now, Later, and Manual.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-ReplicaCreationMethod -ProtectionGroup $pg

This command returns the replica creation method for Trial PG.

REMARKS

For more information, type: "get-help Get-ReplicaCreationMethod -detailed".

For technical information, type: "get-help Get-ReplicaCreationMethod -full".

Set-ReplicaCreationMethod

SYNOPSIS

Set the replica creation method for disk-based protection.

SYNTAX

Set-ReplicaCreationMethod -Now -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-ReplicaCreationMethod -Manual -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-ReplicaCreationMethod -Later <DateTime> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-ReplicaCreationMethod cmdlet allows you to specify the replica creation method disk-based protection.

The possible values are Now, Later, and Manual. If you do not specify a value, the default is set to Now.

The Set-ReplicaCreationMethod cmdlet is the second step to change the replica creation method that is specified for a protection group. First, you must retrieve the replica creation method by using the Get-ReplicaCreationMethod cmdlet.

This cmdlet can only be used if the protection is set to ShortTerm for Disk. For any other setting it will show an error. Specifically, this cmdlet does not apply to tape-based protection.

PARAMETERS

-Later <DateTime>

The time at which the operation should be performed.

-Manual

Indicates that the settings will be made manually.

-Now

Indicates that the replica has to be created immediately.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

$mpg = Get-ModifiableProtectionGroup $pg

Set-ReplicaCreationMethod -ProtectionGroup $mpg -Later "23 April 2007"

Set-ProtectionGroup $mpg

This command sets the date for creation of a replica for Trial PG to April 23, 2007.

REMARKS

For more information, type: "get-help Set-ReplicaCreationMethod -detailed".

For technical information, type: "get-help Set-ReplicaCreationMethod -full".

SearchOption

New-SearchOption

SYNOPSIS

Builds an object with the search options to search for a particular string within the set of specified recovery points.

SYNTAX

New-SearchOption [-ToRecoveryPoint] <DateTime> [-FromRecoveryPoint] <DateTime> [-SearchType] <SearchFilterType> [-SearchDetail] <SearchForDetail> [-SearchString] <String> [-Location <String> ] [-Recursive] [ <CommonParameters> ]

DETAILED DESCRIPTION

The New-SearchOption builds an object with the search options to search for a particular string within the set of specified recovery points.

Use this object within the Get-RecoverableItem to perform the actual search.

PARAMETERS

-ToRecoveryPoint <DateTime>

Indicates the last date of the range within which to search the recovery points.

-FromRecoveryPoint <DateTime>

Indicates the first date of the range within which to search the recovery points.

-SearchType <SearchFilterType>

Indicates the type of comparison to be used for the search. The valid values are: startsWith, contains, endsWith and exactMatch.

-SearchDetail <SearchForDetail>

Indicates what type of object to search for. The valid values are: FilesFolders, MailboxByAlias, MailboxByDisplayName, WssSite, and WssDocuments.

-SearchString <String>

The string to search for.

-Location <String>

The location of the recovery point.

-Recursive

Indicates if the search should be recursive. If this parameter is not used, search will be performed at only one level.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

New-SearchOption -StartTime "26 february 2007" -EndTime "28 may 2007" -Search Detail filesfolders -SearchFilter contains -FilterPath new -StartPath "f:\" -Recursive

This command searches for and returns the recovery points between 26 February 2007 and 28 May 2007.

REMARKS

For more information, type: "get-help New-SearchOption -detailed".

For technical information, type: "get-help New-SearchOption -full".

Tape

Add-Tape

SYNOPSIS

Adds a tape to a DPM library.

SYNTAX

Add-Tape [-DPMLibrary] <Library> [-Async] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Add-Tape cmdlet adds a tape to a DPM library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

-Async

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Add-Tape -DPMLibrary $DPMLib

This command adds a tape to the library.

REMARKS

For more information, type: "get-help Add-Tape -detailed".

For technical information, type: "get-help Add-Tape -full".

Get-Tape

SYNOPSIS

Returns a list of tapes in the library across drives and slots.

SYNTAX

Get-Tape [-RecoveryPointLocation] <RecoverySourceLocation> [ <CommonParameters> ]

Get-Tape [-ProtectionGroup] <ProtectionGroup> [ <CommonParameters> ]

Get-Tape [-DPMLibrary] <Library> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-Tape cmdlet returns a list of tapes in the library across drives and slots.

Using the -DPMLibrary parameter returns the tapes in the specified library.

Using the -ProtectionGroup parameter returns the tapes used by the specified protection group.

Using the -RecoveryPointLocation parameter returns the tapes used by a recovery point.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-DPMLibrary <Library>

A DPM library object.

-RecoveryPointLocation <RecoverySourceLocation>

The location of the recovery point. This is necessary if a recovery item exists in more than one location for the same point in time. For e.g. on a disk and tape, or on two tapes.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Get-Tape -DPMLibrary $DPMLib

This command returns the list of tapes on TestingServer.

REMARKS

For more information, type: "get-help Get-Tape -detailed".

For technical information, type: "get-help Get-Tape -full".

Remove-Tape

SYNOPSIS

Removes a tape from a DPM library.

SYNTAX

Remove-Tape [-Tape] <Media> [-DPMLibrary] <Library> [-Async] [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Remove-Tape cmdlet removes a tape from a DPM library.

PARAMETERS

-Tape <Media>

Indicates a tape object.

-DPMLibrary <Library>

A DPM library object.

-Async

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$Tape = Get-Tape -DPMLibrary $DPMLib

Unlock-DPMLibraryDoor -DPMLibrary $DPMLib

Remove-Tape -DPMLibrary $DPMLib -Tape $Tape[2]

This command removes a tape from the library.

REMARKS

For more information, type: "get-help Remove-Tape -detailed".

For technical information, type: "get-help Remove-Tape -full".

Set-Tape

SYNOPSIS

Marks the specified tape as Archive, Clearner, Free or Not Free.

SYNTAX

Set-Tape [-Tape] <Media> -Free [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-Tape [-Tape] <Media> -NotFree [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-Tape [-Tape] <Media> -Archive [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

Set-Tape [-Tape] <Media> -Cleaner [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-Tape cmdlet marks the specified tape as Archive, Clearner, Free or Not Free.

PARAMETERS

-Tape <Media>

Indicates a tape object.

-Archive

Indicates that the media is an archive.

-Cleaner

Indicates that the tape is a cleaning tape.

-Free

Indicates that the tape is free for use.

-NotFree

Indicates that the tape is not free for use.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$Tape = Get-Tape -DPMLibrary $DPMLib

Set-Tape -Tape $Tape[1] -Free

This command marks the specified tape as Free.

REMARKS

For more information, type: "get-help Set-Tape -detailed".

For technical information, type: "get-help Set-Tape -full".

TapeBackupOption

Get-TapeBackupOption

SYNOPSIS

Returns the library, drive and other backup or archive options for a protection group.

SYNTAX

Get-TapeBackupOption [-ProtectionGroup] <ProtectionGroup> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-TapeBackupOption returns the library, drive and other backup or archive options for a protection group.

PARAMETERS

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Get-TapeBackupOption -ProtectionGroup $pg

This command returns the backup options for the tape.

REMARKS

For more information, type: "get-help Get-TapeBackupOption -detailed".

For technical information, type: "get-help Get-TapeBackupOption -full".

Set-TapeBackupOption

SYNOPSIS

Sets the tape backup and library options for a protection group.

SYNTAX

Set-TapeBackupOption -ProtectionGroup <ProtectionGroup> -ShortTerm <Nullable`1> [-CompressData] [-EncryptData] [-PassThru <SwitchParameter> ] [-PerformIntegritycheck] [<CommonParameters>]

Set-TapeBackupOption -BackupLibrary <Library> -DrivesAllocated <Int32> -ProtectionGroup <ProtectionGroup> [-PassThru <SwitchParameter> ] [-TapeCopyLibrary <Library> ] [ <CommonParameters> ]

Set-TapeBackupOption -LongTerm -ProtectionGroup <ProtectionGroup> [-CompressData] [-EncryptData] [-PassThru <SwitchParameter> ] [-PerformIntegritycheck] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Set-TapeBackupOption sets the tape backup options like library and drive information, and short-term and long-term tape backup options.

The parameters CompressData and EncryptData cannot be run together. To remove data compression and encryption, run the cmdlet with neither parameter.

Long-term and short-term setting cannot be made at the same time. Run the cmdlet individually for each set of settings.

PARAMETERS

-BackupLibrary <Library>

The library used for backup.

-DrivesAllocated <Int32>

Number of drives allocated to be used in protection.

-LongTerm

Indicates that the protection group is set to long-term tape protection.

-ProtectionGroup <ProtectionGroup>

Name of a protection group.

-ShortTerm <Nullable`1>

Indicates that the protection group will be on disk, tape or none, if nothing is specified.

-CompressData

Indicates that on-wire compression of data must be enabled while archiving.

-EncryptData

Indicates whether the data should be encrypted during backup.

-PassThru <SwitchParameter>

-PerformIntegritycheck

Indicates that an integrity check must be performed on the tape.

-TapeCopyLibrary <Library>

The secondary tape library is used while making copies of the tape in the backup library.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$pg = Get-ProtectionGroup -DPMServerName TestingServer

Set-TapeBackupOption -ProtectionGroup $pg -ShortTerm -EncryptData

This command sets the tape backup options to short-term backup with encryption.

EXAMPLE 2

$pg = Get-ProtectionGroup TestingServer

$mpg = Get-ModifiableProtectionGroup -ProtectionGroup $pg[0]

$Lib = Get-DPMLibrary TestingServer

Set-TapeBackupOption -ProtectionGroup $mpg -BackupLibrary $Lib -DrivesAllocated 1

Set-ProtectionGroup $mpg

REMARKS

For more information, type: "get-help Set-TapeBackupOption -detailed".

For technical information, type: "get-help Set-TapeBackupOption -full".

TapeDrive

Disable-TapeDrive

SYNOPSIS

Disables the specified tape drives in the library.

SYNTAX

Disable-TapeDrive [-TapeDrive] <Drive> [-Confirm] [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Disable-TapeDrive cmdlet disables the specified tape drives in the library.

PARAMETERS

-TapeDrive <Drive>

Specifies the tape drive to use.

-Confirm

Asks the user to confirm the action.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Get-TapeDrive -DPMLibrary $DPMLib

Disable-TapeDrive -TapeDrive $TapeDrive

This command disables the tape drive on TestingServer.

REMARKS

For more information, type: "get-help Disable-TapeDrive -detailed".

For technical information, type: "get-help Disable-TapeDrive -full".

Enable-TapeDrive

SYNOPSIS

Enables the specified tape drives in the library.

SYNTAX

Enable-TapeDrive [-TapeDrive] <Drive> [-PassThru <SwitchParameter> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Enable-TapeDrive cmdlet enables the specified tape drives in the library.

PARAMETERS

-TapeDrive <Drive>

Specifies the tape drive to use.

-PassThru <SwitchParameter>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Get-TapeDrive -DPMLibrary $DPMLib

Enable-TapeDrive -TapeDrive $TapeDrive

This command enables the tape drive on a library attached to TestingServer.

REMARKS

For more information, type: "get-help Enable-TapeDrive -detailed".

For technical information, type: "get-help Enable-TapeDrive -full".

Get-TapeDrive

SYNOPSIS

Returns a list of drives in a library on a DPM server.

SYNTAX

Get-TapeDrive [-DPMLibrary] <Library> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-TapeDrive cmdlet returns a list of drives in a library on a DPM server.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Get-TapeDrive -DPMLibrary $DPMLib

This command returns the tape drive in all libraries on TestingServer.

REMARKS

For more information, type: "get-help Get-TapeDrive -detailed".

For technical information, type: "get-help Get-TapeDrive -full".

TapeDriveCatalog

Start-TapeDriveCleaning

SYNOPSIS

Starts a clean tape drive job.

SYNTAX

Start-TapeDriveCleaning [-TapeDrive] <Drive> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-TapeDriveCleaning cmdlet starts a clean tape drive job

PARAMETERS

-TapeDrive <Drive>

Specifies the tape drive to use.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$td = Get-TapeDrive -DPMLibrary $DPMLib

Start-TapeDriveCleaning -TapeDrive $td

This command performs a clean tape drive operation.

REMARKS

For more information, type: "get-help Start-TapeDriveCleaning -detailed".

For technical information, type: "get-help Start-TapeDriveCleaning -full".

TapeErase

Start-TapeErase

SYNOPSIS

Starts a tape erase job.

SYNTAX

Start-TapeErase [-Tape] <Media> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-TapeErase cmdlet starts a tape erase job.

PARAMETERS

-Tape <Media>

Indicates a tape object.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$Tape = Get-Tape -DPMLibrary $DPMLib

Start-TapeErase -Tape $Tape[2]

This command erases the contents on the specified tape.

REMARKS

For more information, type: "get-help Start-TapeErase -detailed".

For technical information, type: "get-help Start-TapeErase -full".

TapeRecatalog

Start-TapeRecatalog

SYNOPSIS

Returns information about the data on a tape.

SYNTAX

Start-TapeRecatalog [-Tape] <Media> [-JobStateChangedEventHandler <JobStateChangedEventHandler> ] [ <CommonParameters> ]

DETAILED DESCRIPTION

The Start-TapeRecatalog cmdle returns information about the data on a tape. This is required to be done before recovering data from the tape. Use the Start-OnlineRecatalog cmdlet to do a partial recovery of data on a tape.

PARAMETERS

-Tape <Media>

Indicates a tape object.

-JobStateChangedEventHandler <JobStateChangedEventHandler>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

$Tape = Get-Tape -DPMLibrary $DPMLib

Start-TapeRecatalog -Tape $Tape[2]

This command performs an online recatalog of the data on the specified tape.

REMARKS

For more information, type: "get-help Start-TapeRecatalog -detailed".

For technical information, type: "get-help Start-TapeRecatalog -full".

TapeSlot

Get-TapeSlot

SYNOPSIS

Returns the list of slots in the library.

SYNTAX

Get-TapeSlot [-DPMLibrary] <Library> [ <CommonParameters> ]

DETAILED DESCRIPTION

The Get-TapeSlot cmdlet returns the list of slots in the library.

PARAMETERS

-DPMLibrary <Library>

A DPM library object.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

EXAMPLE 1

$DPMLib = Get-DPMLibrary -DPMServerName "TestingServer"

Get-TapeSlot -DPMLibrary $DPMLib

This command returns the tape slot in the library.

REMARKS

For more information, type: "get-help Get-TapeSlot -detailed".

For technical information, type: "get-help Get-TapeSlot -full".