New-FsrmFileGroup
Creates a file group.
Syntax
New-FsrmFileGroup
[-Name] <String>
[-AsJob]
[-CimSession <CimSession[]>]
[-Description <String>]
[-ExcludePattern <String[]>]
[-IncludePattern <String[]>]
[-ThrottleLimit <Int32>]
[-Confirm]
[-WhatIf]
Description
The New-FsrmFileGroup cmdlet creates a file group object on the server. A file group is a logical collection of file name patterns that the server uses to define file screens and file screen exceptions. You can also use file group definitions for generating storage report jobs based on file type.
The file group consists of two collections of wildcard patterns for file names. One collection indicates file names that the server includes for file screens, and the other collection indicates file names that the server does not include for file screens.
Examples
Example 1: Create a file group
PS C:\>New-FsrmFileGroup -Name "Non-HTML text files" -IncludePattern @("*.txt", "*ml") -ExcludePattern "*.html"
This command creates a file group named "Non-HTML text files". The command indicates that files that end in txt or ml are included in the file group, and that files that end in .html are not included in the file group.
Parameters
-AsJob
ps_cimcommon_asjob
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CimSession
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifies a description for the file group.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ExcludePattern
Specifies an array of pattern strings that can include * and ? as wildcard characters. The strings can be up to 1KB in size.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IncludePattern
Specifies an array of pattern strings that can include * and ? as wildcard characters. The strings can be up to 1KB in size.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies a name for the file group.
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-ThrottleLimit
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |