Set-BEBackupDefinition Help

Synopsis

Sets the properties for a backup definition in Backup Exec.

Syntax

Set-BEBackupDefinition [-BackupDefinition] [<BEBackupDefinition>] [-ExchangePreConsistencyCheck [<Boolean>]] [-ExchangeContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-FileSystemBackupOpenFileIfClosedWithinSeconds [<UInt32>]] [-FileSystemBackupRemoteStorage [<Boolean>]] [-FileSystemBackupOpenFile {Never | IfClosedWithinSpecifiedTime | WithALock | WithoutALock}] [-SharePointPreConsistencyCheck [<Boolean>]] [-SharePointContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-SharePointReleaseLockOnFarmTopology [<Boolean>]] [-ExchangeUseGrt [<Boolean>]] [-ExchangeHighAvailability {FromPassiveCopyIfAvailableOtherwiseActiveCopy | FromPassiveCopyOnly | FromActiveCopyOnly}] [-ProcessOffhostLogicalVolumesSequentially [<Boolean>]] [-RunBackupWhenThreatConLevelReached [<String>]] [-FailIfNoOffhostBackup [<Boolean>]] [-UseOffhostBackup [<Boolean>]] [-OffhostBackupSnapshotProvider {Automatic | Software | Hardware}] [-FileSystemFollowJunctionPoint [<Boolean>]] [-FileSystemFollowSymbolicLink [<Boolean>]] [-FileSystemEnableNtfsSingleInstanceBackup [<Boolean>]] [-ThreatConLevel {Level2 | Level3 | Level4}] [-FileSystemBackupMethod {UseModifiedTime | UseArchiveBit | UseCatalog}] [-SharePointUseGrt [<Boolean>]] [-VirtualMachineUseGrtForSql [<Boolean>]] [-VirtualMachineUseGrtForSharePoint [<Boolean>]] [-VirtualMachineUseGrtForExchange [<Boolean>]] [-VirtualMachineUseGrtForFileSystem [<Boolean>]] [-VirtualMachineUseGrtForActiveDirectory [<Boolean>]] [-VMwareVSpherePort [<UInt32>]] [-HyperVExcludeVirtualMachinesNeedingSavedState [<Boolean>]] [-VMwareTransportModePriority {SAN | NBD | NBDSSL | Hotadd}] [-LinuxMacLockRemoteFile [<Boolean>]] [-ActiveDirectoryPreConsistencyCheck [<Boolean>]] [-LinuxMacFollowRemoteMountPoint [<Boolean>]] [-LinuxMacPreserveChangeTime [<Boolean>]] [-LinuxMacFollowLocalMountPoint [<Boolean>]] [-OracleMinimumNumberOfDevicesRequiredForJob [<UInt32>]] [-VirtualMachineBackupPoweredOffVirtualMachine [<Boolean>]] [-OracleMaximumNumberOfDevicesToUseForResources [<UInt32>]] [-ActiveDirectoryContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-ActiveDirectoryUseGrt [<Boolean>]] [-ProcessLogicalVolumesSequentially [<Boolean>]] [-SharePointHelpSearchSelection {Include | Exclude}] [-SharePointSingleSignOnDatabaseSelection {Include | Exclude}] [-SharePointInfoPathServicesSelection {Include | Exclude}] [-SharePointGlobalSettingsSelection {Include | Exclude}] [-SharePointCentralAdministrationWebApplicationSelection {Include | Exclude}] [-SharePointSharedServiceApplicationSelection [<BESharePointSharedServiceApplicationSelection[]>]] [-SharePointSharedServiceApplicationProxySelection [<BESharePointSharedServiceApplicationProxySelection[]>]] [-SharePointServiceApplicationProxySelection [<BESharePointServiceApplicationProxySelection[]>]] [-SharePointWebApplicationSelection [<BESharePointWebApplicationSelection[]>]] [-SharePointServiceApplicationSelection [<BESharePointServiceApplicationSelection[]>]] [-SystemStateSelection {Include | Exclude}] [-FileSystemSelection [<BEFileSystemSelection[]>]] [-ClearExistingSelection [<SwitchParameter>]] [-EnableSimplifiedDisasterRecovery [<Boolean>]] [-SelectEntireAgentServer [<SwitchParameter>]] [-SharePointAllResourcesSelection {Include | Exclude}] [-SharePointConfigurationDatabaseSelection {Include | Exclude}] [-SqlDatabaseSelection [<BESqlDatabaseSelection[]>]] [-ExchangeStorageGroupDatabaseSelection [<BEExchangeStorageGroupDatabaseSelection[]>]] [-ExchangeDatabaseSelection [<BEExchangeDatabaseSelection[]>]] [-SharePointSharedServiceProviderSelection [<BESharePointSharedServiceProviderSelection[]>]] [-NetworkProtocol {AnyAvailable | IPv4 | IPv6}] [-NetworkSubnet [<BENetworkInterfaceSubnet>]] [-NetworkInterface [<BENetworkInterface>]] [-TestRunJobSizeCalculationMethod {UsePreviousJobHistories | PerformPreScan}] [-TestRunPlaceScheduledBackupJobOnHoldIfUnsuccessful [<Boolean>]] [-SnapshotTechnology {Automatic | MicrosoftVolumeShadowCopyService}] [-SnapshotProvider {Automatic | System | Software | Hardware}] [-UseSnapshotTechnology [<Boolean>]] [-AllowAnyNetworkForAgentAccess [<Boolean>]] [-EnableCheckpointRestart [<Boolean>]] [-RestrictToBackupExecServer [<BEBackupExecServer>]] [-RestrictToBackupExecServersInPool [<BEBackupExecServerPool>]] [-Priority {Normal | Lowest | Low | High | Highest}] [-SharePointPortalSiteSelection [<BESharePointPortalSiteSelection[]>]] [-SharePointServiceSiteSelection [<BESharePointServiceSiteSelection[]>]] [-TestRunCheckStorageSpace [<Boolean>]] [-TestRunCheckMediaAvailable [<Boolean>]] [-TestRunCheckLogonAccount [<Boolean>]] [-EnableTestRun [<Boolean>]] [-TestRunSchedule [<BESchedule>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a backup definition in Backup Exec.

The parameters passed to Set-BEBackupDefinition are options for all of the tasks in the backup definition.

The values of selection parameters passed to Set-BEBackupDefinition are added to the current selections in the backup definition that you want to edit. To clear the existing selections, use ClearExistingSelection.

Set-BEBackupDefinition can be used with the following commands to modify the tasks in the backup definition: Add-BEIncrementalBackupTask, Add-BEDifferentialBackupTask, Add-BEDuplicateStageBackupTask, Add-BEConvertToVirtualStageBackupTask, Add-BEVerifyBackupTask, Set-BEIncrementalBackupTask, Set-BEDifferentialBackupTask, Set-BEDuplicateStageBackupTask, Set-BEVerifyBackupTask, and Remove-BEBackupTask.

When you create or edit a backup definition, the backup definition must be passed to Save-BEBackupDefinition to commit the changes.

Parameters

-EnableSimplifiedDisasterRecovery <Boolean>

Enables Simplified System Recovery.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SelectEntireAgentServer <SwitchParameter>

Selects the entire agent server to be backed up.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ClearExistingSelection <SwitchParameter>

Clears the existing backup selections.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SystemStateSelection

Includes or excludes System State in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemSelection <BEFileSystemSelection[]>

Includes or excludes one or more file system selections in the backup definition. To specify files or directories to include, specify one or more paths using commas to separate the values. To specify files or directories to exclude, use the output of New-BEFileSystemSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangeStorageGroupDatabaseSelection <BEExchangeStorageGroupDatabaseSelection[]>

Includes or excludes one or more Exchange 2003 storage groups or databases in the backup definition. To specify storage groups to include, specify one or more storage group names using commas to separate the values (specifying '*' will include all storage groups). To specify storage groups to exclude, or to specify individual databases to include or exclude, use the output of New-BEExchangeStorageGroupDatabaseSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangeDatabaseSelection <BEExchangeDatabaseSelection[]>

Includes or excludes one or more databases for Exchange 2007 or later in the backup definition. To specify databases to include, specify one or more database names using commas to separate the values (specifying '*' will include all databases). To specify databases to exclude, use the output of New-BEExchangeDatabaseSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SqlDatabaseSelection <BESqlDatabaseSelection[]>

Includes or excludes one or more SQL instances or databases in the backup definition. To specify SQL instances to include, specify one or more SQL instance names using commas to separate the values (specifying '*' will include all SQL instances). To specify SQL instances to exclude, or to specify individual databases to include or exclude, use the output of New-BESqlDatabaseSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointAllResourcesSelection

Includes or excludes all of the SharePoint resources categorically in the backup definition when you back up a Windows computer.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointConfigurationDatabaseSelection

Includes or excludes the SharePoint configuration database in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointGlobalSettingsSelection

Includes or excludes the SharePoint global settings database in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointCentralAdministrationWebApplicationSelection

Includes or excludes the SharePoint Central Administration Web Application in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointInfoPathServicesSelection

Includes or excludes the SharePoint Info Path Services in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointHelpSearchSelection

Includes or excludes the SharePoint Help Search in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointSingleSignOnDatabaseSelection

Includes or excludes the SharePoint Single Sign-on Database in the backup definition.

The valid values are:
Include
Exclude

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointWebApplicationSelection <BESharePointWebApplicationSelection[]>

Includes or excludes one or more SharePoint Web Applications in the backup definition. To specify Web Applications to include, specify one or more Web Application names using commas to separate the values (specifying '*' will include all Web Applications). To specify Web Applications to exclude, use the output of New-BESharePointWebApplicationSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointServiceApplicationSelection <BESharePointServiceApplicationSelection[]>

Includes or excludes one or more SharePoint Service Applications in the backup definition. To specify Service Applications to include, specify one or more Service Application names using commas to separate the values (specifying '*' will include all Service Applications). To specify Service Applications to exclude, use the output of New-BESharePointServiceApplicationSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointServiceApplicationProxySelection <BESharePointServiceApplicationProxySelection[]>

Includes or excludes one or more SharePoint Service Application Proxies in the backup definition. To specify Service Application Proxies to include, specify one or more Service Application Proxy names using commas to separate the values (specifying '*' will include all Service Application Proxies). To specify Service Application Proxies to exclude, use the output of New-BESharePointServiceApplicationProxySelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointSharedServiceApplicationSelection <BESharePointSharedServiceApplicationSelection[]>

Includes or excludes one or more SharePoint Shared Service Applications in the backup definition. To specify Shared Service Applications to include, specify one or more Shared Service Application names using commas to separate the values (specifying '*' will include all Shared Service Applications). To specify Shared Service Applications to exclude, use the output of New-BESharePointSharedServiceApplicationSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointSharedServiceApplicationProxySelection <BESharePointSharedServiceApplicationProxySelection[]>

Includes or excludes one or more SharePoint Shared Service Application Proxies in the backup definition. To specify Shared Service Application Proxies to include, specify one or more Shared Service Application Proxy names using commas to separate the values (specifying '*' will include all Shared Service Application Proxies). To specify Shared Service Application Proxies to exclude, use the output of New-BESharePointSharedServiceApplicationProxySelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointSharedServiceProviderSelection <BESharePointSharedServiceProviderSelection[]>

Includes or excludes one or more SharePoint Shared Service Providers in the backup definition. To specify Shared Service Providers to include, specify one or more Shared Service Provider names using commas to separate the values. To specify Shared Service Providers to exclude, use the output of New-BESharePointSharedServiceProviderSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointPortalSiteSelection <BESharePointPortalSiteSelection[]>

Includes or excludes one or more SharePoint Portal Sites in the backup definition. To specify Portal Sites to include, specify one or more Portal Site names using commas to separate the values. To specify Portal Sites to exclude, use the output of New-BESharePointPortalSiteSelection with the -Exclude parameter to pass one or more Portal Sites to exclude to this parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointServiceSiteSelection <BESharePointServiceSiteSelection[]>

Includes or excludes one or more SharePoint Service Sites in the backup definition. To specify Service Sites to include, specify one or more Service Site names using commas to separate the values. To specify Service Sites to exclude, use the output of New-BESharePointServiceSiteSelection with the -Exclude parameter.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Priority

Specifies the order that the job runs. If two jobs are scheduled to run at the same time, the priority you set determines which job runs first.

The valid values are:
Normal
Lowest
Low
High
Highest

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-RestrictToBackupExecServer <BEBackupExecServer>

Specifies the Backup Exec server to which the job can be dispatched in a CASO environment. Cannot be specified if RestrictToBackupExecServersInPool is specified.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-RestrictToBackupExecServersInPool <BEBackupExecServerPool>

Specifies a set of Backup Exec servers to which the job can be dispatched in a CASO environment. Cannot be specified if RestrictToBackupExecServer is specified.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-EnableTestRun <Boolean>

Enables the test run process.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunSchedule <BESchedule>

Lets you schedule the time and how often the test run job runs.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunCheckLogonAccount <Boolean>

Verifies that the Backup Exec logon account is correct for the data that you want to back up.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunCheckStorageSpace <Boolean>

Tests if there is enough available capacity on the media to complete the job.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunCheckMediaAvailable <Boolean>

Tests if the media is online and able to be overwritten.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunJobSizeCalculationMethod

Specifies how to calculate if enough media is available to run the scheduled backup job.

The valid values are:
UsePreviousJobHistories
PerformPreScan

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TestRunPlaceScheduledBackupJobOnHoldIfUnsuccessful <Boolean>

Places the scheduled job on hold if Backup Exec detects any failures during the test run.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-NetworkInterface <BENetworkInterface>

Specifies the name of the network interface card that connects the Backup Exec server to the network you want to use for the backup network. See Get-BENetworkInterface.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-NetworkProtocol

Specifies the protocol you want to used to back up remote computers.

The valid values are:
AnyAvailable
IPv4
IPv6

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-NetworkSubnet <BENetworkInterfaceSubnet>

Specifies the subnet you want to use to back up remote computers on by using one of the subnets of a network interface returned by Get-BENetworkInterface.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-AllowAnyNetworkForAgentAccess <Boolean>

Ensures that the data from the remote computer is backed up or restored over any available network if the remote computer that you select for backup or restore is not part of the specified backup network.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-EnableCheckpointRestart <Boolean>

Enables backup jobs to continue from the point at which the jobs was interrupted.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-UseSnapshotTechnology <Boolean>

Enables the use of a snapshot technology

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SnapshotTechnology

Specifies the snapshot technology to use when you enable snapshot technology. UseSnapshotTechnology must be set to $true.

The valid values are:
Automatic
MicrosoftVolumeShadowCopyService

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SnapshotProvider

Specifies the Microsoft Volume Shadow Copy Service as the snapshot provider to use when you enable snapshot technology. UseSnapshotTechnology must be set to $true and SnapshotTechnology must be set to MicrosoftVolumeShadowCopyService.

The valid values are:
Automatic
System
Software
Hardware

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ProcessLogicalVolumesSequentially <Boolean>

Enables the backup of multiple volumes in one job, while creating a snapshot of only one logical volume at a time.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-UseOffhostBackup <Boolean>

Enables offhost backup. If enabled, then an offhost backup of all volumes will be performed if all requirements are met.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-OffhostBackupSnapshotProvider

Specifies the offhost backup snapshot provider to use. UseOffhostBackup must be set to $true.

The valid values are:
Automatic
Software
Hardware

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FailIfNoOffhostBackup <Boolean>

Terminates the backup job if any of the volumes selected do not support offhost backup, or if an error occurs that is related to the snapshot or volume import. UseOffhostBackup must be set to $true.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ProcessOffhostLogicalVolumesSequentially <Boolean>

Enables the backup of multiple volumes in one job, while creating a snapshot of only one logical volume at a time for offhost backups. UseOffhostBackup must be set to $true.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-RunBackupWhenThreatConLevelReached <String>

Runs automatic backup jobs when the ThreatCon reaches a level that you specify.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ThreatConLevel

Specifies the ThreatCon level at which you want backup jobs to run. RunJobAfterThreatConLevelReached must be set to $true.

The valid values are:
Level2
Level3
Level4

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemBackupMethod

Specifies the backup method to use to back up files and folders.

The valid values are:
UseModifiedTime
UseArchiveBit
UseCatalog

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemEnableNtfsSingleInstanceBackup <Boolean>

Lets Backup Exec check the NTFS volume for identical files. If Backup Exec finds multiple copies of a file, only one instance of that file is backed up.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemFollowJunctionPoint <Boolean>

Backs up the information for the junction points and the files and directories to which they are linked.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemFollowSymbolicLink <Boolean>

Backs up the information for the symbolic links and the files and directories to which they are linked.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemBackupRemoteStorage <Boolean>

Backs up data that has been migrated from primary storage to secondary storage.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemBackupOpenFile

Specifies how Backup Exec processes any open files for the backup job if snapshot technology is not used.

The valid values are:
Never
IfClosedWithinSpecifiedTime
WithALock
WithoutALock

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-FileSystemBackupOpenFileIfClosedWithinSeconds <UInt32>

The number of seconds Backup Exec waits for files to close before skipping them and continuing the backup job. BackupOpenFile must be set to IfClosedWithinSpecifiedTime.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangePreConsistencyCheck <Boolean>

Performs a consistency check before running the backup job.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangeContinueIfConsistencyCheckIsUnsuccessful <Boolean>

Continues the backup job even if the consistency check fails.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangeUseGrt <Boolean>

Enables restores of individual items from Information Store backup jobs.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ExchangeHighAvailability

Specifies a backup source for Exchange 2007 or later.

The valid values are:
FromPassiveCopyIfAvailableOtherwiseActiveCopy
FromPassiveCopyOnly
FromActiveCopyOnly

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointReleaseLockOnFarmTopology <Boolean>

Releases the lock on the SharePoint farm topology before you run the backup job.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointPreConsistencyCheck <Boolean>

Runs a full consistency check (including indexes) of the Microsoft SQL databases used by Microsoft SharePoint before you back up the databases.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointContinueIfConsistencyCheckIsUnsuccessful <Boolean>

Continues with the backup job even if the consistency check fails.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SharePointUseGrt <Boolean>

Enables the restore of individual documents, images, sites, subsites, lists, and list items from backups of the database.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-LinuxMacPreserveChangeTime <Boolean>

Prevents the Agent of Windows from changing an object's attributes when a backup job occurs. An object is a file or a directory.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-LinuxMacFollowLocalMountPoint <Boolean>

Lets Backup Exec follow local mount points when it backs up data.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-LinuxMacFollowRemoteMountPoint <Boolean>

Lets Backup Exec follow remote mount points when it backs up data.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-LinuxMacLockRemoteFile <Boolean>

Lets the Agent for Windows have exclusive access to the files on the remote computers that are connected through Network File System (NFS).

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ActiveDirectoryPreConsistencyCheck <Boolean>

Checks snapshots for data corruption.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ActiveDirectoryContinueIfConsistencyCheckIsUnsuccessful <Boolean>

Enables the backup job to continue even if the consistency check fails.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ActiveDirectoryUseGrt <Boolean>

Enables the restore of individual items from full backups of the Active Directory.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-OracleMaximumNumberOfDevicesToUseForResources <UInt32>

Specifies the maximum number of devices that the backup job can use.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-OracleMinimumNumberOfDevicesRequiredForJob <UInt32>

Specifies the minimum number of devices that the job can use.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineBackupPoweredOffVirtualMachine <Boolean>

Enables Backup Exec to back up virtual machines that are turned off.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineUseGrtForFileSystem <Boolean>

Enables individual files and folders to be restored from the full backup job.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineUseGrtForActiveDirectory <Boolean>

Enables Backup Exec to collect the information that is required to restore individual Active Directory objects on the virtual machine.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineUseGrtForExchange <Boolean>

Enables Backup Exec to collect the information that is required to restore individual Exchange databases and mailbox items on the virtual machine.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineUseGrtForSql <Boolean>

Enables Backup Exec to collect the information that is required to restore individual SQL database items on the virtual machine.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineUseGrtForSharePoint <Boolean>

Enables Backup Exec to collect the information that is required to restore SharePoint data on the virtual machine.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-HyperVExcludeVirtualMachinesNeedingSavedState <Boolean>

Excludes all offline virtual machines that do not support online backups and that are in a running state when the backup starts.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VMwareTransportModePriority

Specifies one or more VMware transport modes Backup Exec should use in order of their priority.

The valid values are:
SAN
NBD
NBDSSL
Hotadd

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VMwareVSpherePort <UInt32>

Specifies the VMware vSphere port Backup Exec should use.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-BackupDefinition <BEBackupDefinition>

Specifies the backup definition to edit.

Required	true
Position	0
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

BackupExec.Management.CLI.BEBackupDefinition

You can pipe a Backup Exec backup definition object to Set-BEBackupDefinition.

Return Value

BackupExec.Management.CLI.BEBackupDefinition

The backup definition that has been modified.

Examples

Example 1

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Set-BEBackupDefinition -FileSystemSelection D:\* | Save-BEBackupDefinition

These commands add D:\* as a backup selection to the current selections in the backup definition named "Backup Definition 01".

Example 2

C:\PS> Get-BEBackupDefinition "Backup Definition 01" | Set-BEBackupDefinition -ClearExistingSelection -FileSystemSelection D:\* | Save-BEBackupDefinition

These commands set D:\* as the only backup selection in the backup definition named "Backup Definition 01".