New-WBFileSpec

New-WBFileSpec

Creates a backup file specification.

Syntax

Parameter Set: Default
New-WBFileSpec [-FileSpec] <String[]> [[-NonRecursive]] [[-Exclude]] [ <CommonParameters>]

Detailed Description

The New-WBFileSpec cmdlet creates a WBFileSpec object that contains a backup file specification. A WBFileSpec object defines the items the items that a backup includes or excludes. You can add a backup file specification to a WBPolicy object as a source for backup.

You can use this cmdlet to include multiple files, folders, or volumes. Specify volume paths by using volume drive letters, volume mount points, or GUID-based volume names. If you use a GUID-based volume name, ensure that it ends with a backslash (\). You can use wildcard characters (*) in file names to specify a path to a file or to specify a file type to include or exclude.

If you specify a path to exclude from the backup, that path must be part of an inclusion file specification in the policy. Otherwise, the backup ignores the exclusion path.

Parameters

-Exclude

Indicates that the backup excludes the items in the FileSpec parameter from the backup.

-FileSpec<String[]>

Specifies a list of names of items to include in or exclude from the backup. This parameter can include file paths and volumes (such as "C:\") or file specifications (such as "C:\dir1\*.*").

-NonRecursive

Indicates that the backup includes only the items in the WBFileSpec object and not subordinate items. If you do not include this option, the backup includes items recursively.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Spec string, NonRecursive, Excluded flags

  The New-WBFileSpec cmdlet uses Spec, NonRecursive, and Excluded parameters to create a list of items to include or exclude. Spec accepts string objects.

Outputs

The output type is the type of the objects that the cmdlet emits.

• WBFileSpec

  The New-WBFileSpec cmdlet displays a WBFileSpec object, which describes a file specification. You can add a WBFileSpec object to a WBPolicy object as a source for backup.

Examples

Example 1: Add a file to a backup file specification

This command creates a file specification and adds the file named "C:\Sample\1.jpg" to it.

PS C:\> $Filespec = New-WBFileSpec -FileSpec C:\Sample\1.jpg

The WBFileSpec object that specifies the file C:\Sample\1.jpg for backup.

Example 2: Add a volume recursively to a backup file specification

This command creates a file specification and adds the contents of the "C:\Sample" folder to it. Because the cmdlet does not include the NonRecursive parameter, the backup includes the contents of this folder and its subfolders.

PS C:\> $Filespec = New-WBFileSpec -FileSpec C:\Sample

The WBFileSpec object that specifies the folder C:\Sample for backup.

Example 3: Add a volume nonrecursively to a backup file specification

This command creates a file specification and adds the contents of the "C:\Sample" folder to it. Because the cmdlet includes the NonRecursive parameter, the backup includes the contents of this folder but not the contents of its subfolders.

PS C:\> $Filespec = New-WBFileSpec -FileSpec C:\Sample -NonRecursive

The WBFileSpec object that specifies the folder C:\sample for backup non-recursively.

Example 4: Exclude files from a backup file specification

This command creates an exclusion file specification for MP3 files in the "C:\Sample" folder. The backup excludes MP3 files in "C:\Sample" and its subfolders.

PS C:\> $Filespec = New-WBFileSpec -FileSpec C:\Sample\*.mp3 -Exclude

The WBFileSpec object that specifies the exclusion of*.mp3 files during backup under the path C:\Sample.

Related topics

Add-WBFileSpec

Get-WBFileSpec

Remove-WBFileSpec