Backup Exec Management Command Line Interface Help
Set-BEBackupJobDefault Cmdlet
Synopsis

Sets the properties for the job defaults in Backup Exec.

Syntax
Set-BEBackupJobDefault [-BackupJobDefault] [<BEBackupJobDefaults>] [-LinuxMacFollowRemoteMountPoint [<Boolean>]] [-LinuxMacFollowLocalMountPoint [<Boolean>]] [-LinuxMacPreserveChangeTime [<Boolean>]] [-ActiveDirectoryContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-ActiveDirectoryPreConsistencyCheck [<Boolean>]] [-LinuxMacLockRemoteFile [<Boolean>]] [-SharePointUseGrt [<Boolean>]] [-ExchangeHighAvailability {FromPassiveCopyIfAvailableOtherwiseActiveCopy | FromPassiveCopyOnly | FromActiveCopyOnly}] [-ExchangeUseGrt [<Boolean>]] [-ExchangeContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-SharePointContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-SharePointPreConsistencyCheck [<Boolean>]] [-SharePointReleaseLockOnFarmTopology [<Boolean>]] [-ActiveDirectoryUseGrt [<Boolean>]] [-VMwareTransportModePriority {SAN | NBD | NBDSSL | Hotadd}] [-HyperVExcludeVirtualMachinesNeedingSavedState [<Boolean>]] [-VirtualMachineUseGrtForSharePoint [<Boolean>]] [-VMwareVSpherePort [<UInt32>]] [-VirtualMachineUseGrtForSql [<Boolean>]] [-VirtualMachineBackupPoweredOffVirtualMachine [<Boolean>]] [-OracleMinimumNumberOfDevicesRequiredForJob [<UInt32>]] [-OracleMaximumNumberOfDevicesToUseForResources [<UInt32>]] [-VirtualMachineUseGrtForExchange [<Boolean>]] [-VirtualMachineUseGrtForActiveDirectory [<Boolean>]] [-VirtualMachineUseGrtForFileSystem [<Boolean>]] [-ExchangePreConsistencyCheck [<Boolean>]] [-EnableCheckpointRestart [<Boolean>]] [-TestRunPlaceScheduledBackupJobOnHoldIfUnsuccessful [<Boolean>]] [-TestRunJobSizeCalculationMethod {UsePreviousJobHistories | PerformPreScan}] [-SnapshotProvider {Automatic | System | Software | Hardware}] [-SnapshotTechnology {Automatic | MicrosoftVolumeShadowCopyService}] [-UseSnapshotTechnology [<Boolean>]] [-TestRunCheckMediaAvailable [<Boolean>]] [-EnableTestRun [<Boolean>]] [-RestrictToBackupExecServersInPool [<BEBackupExecServerPool>]] [-RestrictToBackupExecServer [<BEBackupExecServer>]] [-TestRunCheckStorageSpace [<Boolean>]] [-TestRunCheckLogonAccount [<Boolean>]] [-TestRunSchedule [<BESchedule>]] [-ProcessLogicalVolumesSequentially [<Boolean>]] [-FileSystemFollowSymbolicLink [<Boolean>]] [-FileSystemFollowJunctionPoint [<Boolean>]] [-FileSystemEnableNtfsSingleInstanceBackup [<Boolean>]] [-FileSystemBackupOpenFileIfClosedWithinSeconds [<UInt32>]] [-FileSystemBackupOpenFile {Never | IfClosedWithinSpecifiedTime | WithALock | WithoutALock}] [-FileSystemBackupRemoteStorage [<Boolean>]] [-FileSystemBackupMethod {UseModifiedTime | UseArchiveBit | UseCatalog}] [-FailIfNoOffhostBackup [<Boolean>]] [-OffhostBackupSnapshotProvider {Automatic | Software | Hardware}] [-UseOffhostBackup [<Boolean>]] [-ThreatConLevel {Level2 | Level3 | Level4}] [-RunBackupWhenThreatConLevelReached [<String>]] [-ProcessOffhostLogicalVolumesSequentially [<Boolean>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]
Description

Sets the properties for the job defaults in Backup Exec.

The parameters passed to Set-BEBackupJobDefault are options for all of the tasks in the backup job defaults.

Set-BEBackupJobDefault can be used with the following commands to modify the tasks in the backup job defaults: Get-BEBackupJobDefault, Add-BEIncrementalBackupTask, Add-BEDifferentialBackupTask, Add-BEVerifyBackupTask, Set-BEIncrementalBackupTask, Set-BEDifferentialBackupTask, Set-BEVerifyBackupTask, and Remove-BEBackupTask.

When you edit backup job defaults, the backup job defaults must be passed to Save-BEBackupJobDefault to commit the changes.

Parameters

-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


-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 automatic backup jobs run. RunBackupAfterThreatConLevelReached must be set.

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


-BackupJobDefault <BEBackupJobDefaults>

Specifies the backup job defaults to modify.


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


<CommonParameters>

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

Input Type
BackupExec.Management.CLI.BEBackupJobDefaults

You can pipe a Backup Exec backup job default object to Set-BEBackupJobDefault.

Return Value
BackupExec.Management.CLI.BEBackupJobDefaults

Set-BEBackupJobDefault returns the modified backup job defaults.

Example
C:\PS> Get-BEBackupJobDefault BackupToTape | Set-BEBackupJobDefault -Priority High | Save-BEBackupJobDefault

These commands set default backup-to-tape job priority to "High".

Related Links

Get-BEBackupJobDefault
Add-BEIncrementalBackupTask
Add-BEDifferentialBackupTask
Add-BEVerifyBackupTask
Set-BEIncrementalBackupTask
Set-BEDifferentialBackupTask
Set-BEVerifyBackupTask
Remove-BEBackupTask
Save-BEBackupJobDefault