Submit-BEOnetimeBackupJob Help

Synopsis

Submits a one time backup job in Backup Exec.

Syntax

Submit-BEOnetimeBackupJob -AgentServer [<BEAgentServer>] [-DiskStorageKeepForHours [<Int32>]] [-SubmitOnHold [<Boolean>]] [-BackupSetDescription [<String>]] [-TapeStorageRetensionMediaBeforeBackup [<Boolean>]] [-TapeStorageEjectMediaAfterComplete [<Boolean>]] [-TapeStorageEnableWriteOnceReadManyMedia [<Boolean>]] [-TapeStorageEnableDirectCopyToTape [<Boolean>]] [-EnableDirectAccessIfAvailable [<Boolean>]] [-StartDate [<DateTime>]] [-PreCommand [<String>]] [-TapeStorageMediaAppendMethod {Append | AppendOnly | Overwrite}] [-KeepJobQueuedFor [<TimeSpan>]] [-CancelJobIfRunningAfterScheduledTimeBy [<TimeSpan>]] [-TapeStorageCompressionMethod {None | SoftwareIfNoHardware | HardwareOnly | SoftwareOnly}] [-TapeStorageExportMediaToVault [<BEMediaVault>]] [-VirtualMachineUseGrtForActiveDirectory [<Boolean>]] [-VirtualMachineUseGrtForExchange [<Boolean>]] [-VirtualMachineUseGrtForSql [<Boolean>]] [-VirtualMachineUseGrtForFileSystem [<Boolean>]] [-OracleMaximumNumberOfDevicesToUseForResources [<UInt32>]] [-OracleMinimumNumberOfDevicesRequiredForJob [<UInt32>]] [-VirtualMachineBackupPoweredOffVirtualMachine [<Boolean>]] [-Storage [<BEStorage>]] [-TapeStorageMediaSet [<BEMediaSet>]] [-TapeStorageExportMedia [<Boolean>]] [-VMwareVSpherePort [<UInt32>]] [-VirtualMachineUseGrtForSharePoint [<Boolean>]] [-HyperVExcludeVirtualMachinesNeedingSavedState [<Boolean>]] [-VMwareTransportModePriority {SAN | NBD | NBDSSL | Hotadd}] [-OracleDeleteBackedUpArchivedLogFile [<Boolean>]] [-OracleSkipBackedUpArchivedLogFile [<Boolean>]] [-OraclePerformBackupOffline [<Boolean>]] [-SqlUseSoftwareCompression [<Boolean>]] [-SqlUseChecksumOnBackup [<Boolean>]] [-SqlCreateDiskCopy [<Boolean>]] [-SqlDiskCopyPath [<String>]] [-Name [<String>]] [-DeleteSelectedFilesAfterSuccessfulBackup {Never | FilesOnly | FilesAndFolders}] [-SqlBackupMethod {FullCopy | DatabaseSnapshot | LogNoTruncate | Log}] [-SqlAdvancedLogBackupOption {None | NoRecover | Standby}] [-SqlPostConsistencyCheck {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-RunPostCommandEvenIfJobIsUnsuccessful [<Boolean>]] [-RunPostCommandAfterVerification [<Boolean>]] [-CancelPrePostCommandIfNotCompleteWithinMinutes [<UInt32>]] [-RunPostCommandOnlyIfPreCommandIsSuccessful [<Boolean>]] [-PostCommand [<String>]] [-PrePostCommandSuccessfulIfReturnsZero [<Boolean>]] [-RunJobOnlyIfPreCommandIsSuccessful [<Boolean>]] [-EncryptionKey [<BEEncryptionKey>]] [-SqlPreConsistencyCheckMethod {None | Physical | FullExcludingIndexes | FullIncludingIndexes}] [-SqlContinueIfConsistencyCheckUnsuccessful [<Boolean>]] [-EncryptionType {None | Software | Hardware | SoftwareIfNoHardware}] [-RunCommandLocation {OnEachAgentServer | OnBackupExecServer}] [-Verify {None | AsPartOfJob | AsSeparateJobImmediatelyAfter}] [-EnableDirectAccessForVerifyJobIfAvailable [<Boolean>]] [-SharePointPortalSiteSelection [<BESharePointPortalSiteSelection[]>]] [-SharePointServiceSiteSelection [<BESharePointServiceSiteSelection[]>]] [-Priority {Normal | Lowest | Low | High | Highest}] [-SharePointSharedServiceProviderSelection [<BESharePointSharedServiceProviderSelection[]>]] [-SharePointServiceApplicationProxySelection [<BESharePointServiceApplicationProxySelection[]>]] [-SharePointSharedServiceApplicationSelection [<BESharePointSharedServiceApplicationSelection[]>]] [-SharePointSharedServiceApplicationProxySelection [<BESharePointSharedServiceApplicationProxySelection[]>]] [-NetworkSubnet [<BENetworkInterfaceSubnet>]] [-AllowAnyNetworkForAgentAccess [<Boolean>]] [-EnableCheckpointRestart [<Boolean>]] [-NetworkProtocol {AnyAvailable | IPv4 | IPv6}] [-RestrictToBackupExecServer [<BEBackupExecServer>]] [-RestrictToBackupExecServersInPool [<BEBackupExecServerPool>]] [-NetworkInterface [<BENetworkInterface>]] [-SharePointServiceApplicationSelection [<BESharePointServiceApplicationSelection[]>]] [-ExchangeDatabaseSelection [<BEExchangeDatabaseSelection[]>]] [-SqlDatabaseSelection [<BESqlDatabaseSelection[]>]] [-SharePointAllResourcesSelection {Include | Exclude}] [-ExchangeStorageGroupDatabaseSelection [<BEExchangeStorageGroupDatabaseSelection[]>]] [-EnableSimplifiedDisasterRecovery [<Boolean>]] [-SystemStateSelection {Include | Exclude}] [-FileSystemSelection [<BEFileSystemSelection[]>]] [-SharePointHelpSearchSelection {Include | Exclude}] [-SharePointSingleSignOnDatabaseSelection {Include | Exclude}] [-SharePointWebApplicationSelection [<BESharePointWebApplicationSelection[]>]] [-SharePointInfoPathServicesSelection {Include | Exclude}] [-SharePointConfigurationDatabaseSelection {Include | Exclude}] [-SharePointGlobalSettingsSelection {Include | Exclude}] [-SharePointCentralAdministrationWebApplicationSelection {Include | Exclude}] [-SharePointPreConsistencyCheck [<Boolean>]] [-SharePointContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-SharePointUseGrt [<Boolean>]] [-SharePointReleaseLockOnFarmTopology [<Boolean>]] [-ExchangeContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-ExchangeUseGrt [<Boolean>]] [-ExchangeHighAvailability {FromPassiveCopyIfAvailableOtherwiseActiveCopy | FromPassiveCopyOnly | FromActiveCopyOnly}] [-ActiveDirectoryPreConsistencyCheck [<Boolean>]] [-ActiveDirectoryContinueIfConsistencyCheckIsUnsuccessful [<Boolean>]] [-ActiveDirectoryUseGrt [<Boolean>]] [-LinuxMacLockRemoteFile [<Boolean>]] [-LinuxMacPreserveChangeTime [<Boolean>]] [-LinuxMacFollowLocalMountPoint [<Boolean>]] [-LinuxMacFollowRemoteMountPoint [<Boolean>]] [-ExchangePreConsistencyCheck [<Boolean>]] [-UseOffhostBackup [<Boolean>]] [-OffhostBackupSnapshotProvider {Automatic | Software | Hardware}] [-FailIfNoOffhostBackup [<Boolean>]] [-ProcessLogicalVolumesSequentially [<Boolean>]] [-UseSnapshotTechnology [<Boolean>]] [-SnapshotTechnology {Automatic | MicrosoftVolumeShadowCopyService}] [-SnapshotProvider {Automatic | System | Software | Hardware}] [-FileSystemBackupRemoteStorage [<Boolean>]] [-FileSystemBackupOpenFile {Never | IfClosedWithinSpecifiedTime | WithALock | WithoutALock}] [-FileSystemBackupOpenFileIfClosedWithinSeconds [<UInt32>]] [-FileSystemFollowSymbolicLink [<Boolean>]] [-ProcessOffhostLogicalVolumesSequentially [<Boolean>]] [-FileSystemEnableNtfsSingleInstanceBackup [<Boolean>]] [-FileSystemFollowJunctionPoint [<Boolean>]] [-Force [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Description

Submits a one time backup job in Backup Exec.

When no selection parameters are passed to Submit-BEOnetimeBackupJob, you are prompted before the entire agent server is selected for backup. To avoid the prompt, specify the -Force parameter.

To create scheduled backup jobs, use New-BEBackupDefinition.

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

-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

-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

-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

-Storage <BEStorage>

Specifies the storage device that you want to use for the backup job. See Get-BEStorage.

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

-TapeStorageMediaSet <BEMediaSet>

Specifies the media set to associate with the media. The media is protected from being overwritten based on the settings for the media set. The Storage parameter must be set to a tape-based storage device. See Get-BEMediaSet.

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

-TapeStorageExportMedia <Boolean>

Exports the media from the device when the job completes. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false

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

-TapeStorageExportMediaToVault <BEMediaVault>

Logically moves the media to the specified vault when the job completes. The Storage parameter must be set to a tape-based storage device and TapeStorageExportMedia must be set to $true. See Get-BEMediaVault.

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

-TapeStorageEjectMediaAfterComplete <Boolean>

Ejects the media from the storage device after the job completes. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false

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

-TapeStorageEnableWriteOnceReadManyMedia <Boolean>

Specifies the use of WORM (write once, read many) media for this backup job. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false

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

-TapeStorageEnableDirectCopyToTape <Boolean>

Enables data to be copied from a virtual tape library directly to a physical tape device.

The valid values are:
$true
$false

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

-TapeStorageRetensionMediaBeforeBackup <Boolean>

Retensions the media before data is written to it. The Storage parameter must be set to a tape-based storage device.

The valid values are:
$true
$false

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

-DiskStorageKeepForHours <Int32>

Specifies the number of hours to retain the data on the media before the media can be overwritten. The Storage parameter must be set to a disk-based storage device.

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

-SubmitOnHold <Boolean>

Submits the job with an on-hold status.

The valid values are:
$true
$false

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

-BackupSetDescription <String>

Describes the data that was backed up and the location of the data.

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

-KeepJobQueuedFor <TimeSpan>

Specifies the maximum amount of time past the scheduled start time that Backup Exec considers the job to be missed and reschedules it.

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

-CancelJobIfRunningAfterScheduledTimeBy <TimeSpan>

Specifies the amount of time after the scheduled start time that you want to cancel the job if it is still running.

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

-TapeStorageCompressionMethod

Specifies the type of data compression to use performed by the hardware or software. The Storage parameter must be set to a tape-based storage device.

The valid values are:
None
SoftwareIfNoHardware
HardwareOnly
SoftwareOnly

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

-TapeStorageMediaAppendMethod

Specifies if you want to overwrite or append to the media when the job starts. The Storage parameter must be set to a tape-based storage device.

The valid values are:
Append
AppendOnly
Overwrite

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

-EnableDirectAccessIfAvailable <Boolean>

Allows backup data to be sent directly to the device specified in the Storage parameter from the Agent for Windows if the device supports it.

The valid values are:
$true
$false

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

-StartDate <DateTime>

Indicates when the job should start. If you do not specify this parameter, the job starts immediately.

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

-PreCommand <String>

Specifies a command to run before the backup job.

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

-PostCommand <String>

Specifies a command to run after the backup job.

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

-PrePostCommandSuccessfulIfReturnsZero <Boolean>

Allows Backup Exec to check the return codes of the pre- and post-commands to determine if they completed successfully.

The valid values are:
$true
$false

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

-RunJobOnlyIfPreCommandIsSuccessful <Boolean>

Runs the backup job only if the pre-command is successful. If the pre-command fails, the job does not run.

The valid values are:
$true
$false

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

-RunPostCommandOnlyIfPreCommandIsSuccessful <Boolean>

Runs the post-command only if the pre-command is successful.

The valid values are:
$true
$false

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

-RunPostCommandEvenIfJobIsUnsuccessful <Boolean>

Runs the post-command regardless of whether the job is successful or not.

The valid values are:
$true
$false

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

-RunPostCommandAfterVerification <Boolean>

Runs the post-command after the verification completes if you selected to verify the backup job.

The valid values are:
$true
$false

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

-CancelPrePostCommandIfNotCompleteWithinMinutes <UInt32>

Designates the number of minutes Backup Exec should wait before canceling a pre- or post-command that did not complete.

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

-RunCommandLocation

Determines the location where the pre- and post-command run.

The valid values are:
OnEachAgentServer
OnBackupExecServer

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

-Verify

Runs a verify operation automatically when the backup job completes.

The valid values are:
None
AsPartOfJob
AsSeparateJobImmediatelyAfter

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

-EnableDirectAccessForVerifyJobIfAvailable <Boolean>

Specifies if the Agent for Windows verifies the data if the device specified in the Storage parameter supports it. The Verify parameter must be set to AsSeparateJobImmediatelyAfter.

The valid values are:
$true
$false

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

-EncryptionType

Specifies the type of encryption that you want to use for the backup job.

The valid values are:
None
Software
Hardware
SoftwareIfNoHardware

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

-EncryptionKey <BEEncryptionKey>

Specifies the encryption key that you want to use. EncryptionType must be set to a value other than None.

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

-SqlPreConsistencyCheckMethod

Specifies the type of consistency check to perform before the backup job runs.

The valid values are:
None
Physical
FullExcludingIndexes
FullIncludingIndexes

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

-SqlContinueIfConsistencyCheckUnsuccessful <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

-SqlPostConsistencyCheck

Specifies the type of consistency check to use after the backup job runs.

The valid values are:
None
Physical
FullExcludingIndexes
FullIncludingIndexes

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

-SqlUseChecksumOnBackup <Boolean>

For SQL 2005 or later, adds checksums to the SQL database data being backed up.

The valid values are:
$true
$false

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

-SqlCreateDiskCopy <Boolean>

Creates an on-disk copy of the SQL database being backed up.

The valid values are:
$true
$false

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

-SqlDiskCopyPath <String>

Specifies the path for the on-disk copy of the SQL database being backed up. CreateDiskCopy must be set to $true.

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

-SqlUseSoftwareCompression <Boolean>

For SQL 2008 or later, specifies the compression setting you want to use.

The valid values are:
$true
$false

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

-OracleDeleteBackedUpArchivedLogFile <Boolean>

Lets you delete the archived log files automatically after the backup.

The valid values are:
$true
$false

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

-OracleSkipBackedUpArchivedLogFile <Boolean>

Enables Backup Exec to skip any archived logfiles that were already backed up.

The valid values are:
$true
$false

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

-OraclePerformBackupOffline <Boolean>

Enables Backup Exec to take the database offline before you start the backup job.

The valid values are:
$true
$false

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

-DeleteSelectedFilesAfterSuccessfulBackup

Backs up the selected data, verifies the media, and then deletes the data from the volume. Since the operation deletes the files and you must perform a restore to get the data back, you must specify the Force parameter when enabling this option.

The valid values are:
Never
FilesOnly
FilesAndFolders

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

-SqlBackupMethod

Specifies the SQL backup method you want to use for this backup job.

The valid values are:
FullCopy
DatabaseSnapshot
LogNoTruncate
Log

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

-SqlAdvancedLogBackupOption

Specifies the advanced log backup option you want to use for this backup job.

The valid values are:
None
NoRecover
Standby

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

-Name <String>

Specifies the name of the backup job.

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

-AgentServer <BEAgentServer>

Specifies the object representing the agent server to back up.

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

-Force <SwitchParameter>

Confirms that the DeleteSelectedFilesAfterSuccessfulBackup parameter results in a loss of data and want to continue to use it.

Required	false
Position	Named
Accepts pipeline input	false
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.BEAgentServer

You can pipe a Backup Exec agent server object to Submit-BEOnetimeBackupJob.

Return Value

BackupExec.Management.CLI.BEJob

Submit-BEOnetimeBackupJob returns the job that was submitted.

Examples

Example 1

C:\PS> Get-BEAgentServer -Local | Submit-BEOneTimeBackupJob -Force | Wait-BEJob

These commands submit a one-time backup that backs up all data on the local computer and waits for the job to complete.

Example 2

C:\PS> Get-BEAgentServer -Local | Submit-BEOneTimeBackupJob -SystemStateSelection Include -FileSystemSelection C:\*,D:\*

These commands submit a one-time backup that backs up the System State and the data on the C: and D: drives of the local computer.