Export (0) Print
Expand All
Expand Minimize

Set-FsrmFileGroup

Updated: December 6, 2012

Applies To: Windows Server 2012

Set-FsrmFileGroup

Changes configuration settings for file groups.

Syntax

Parameter Set: Query (cdxml)
Set-FsrmFileGroup [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-ExcludePattern <String[]> ] [-IncludePattern <String[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-FsrmFileGroup -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-ExcludePattern <String[]> ] [-IncludePattern <String[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-FsrmFileGroup cmdlet changes configuration settings for one or more file groups on the server. 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.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies a description for the file group.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExcludePattern<String[]>

Specifies an array of pattern strings that can include * and ? as wildcard characters. The maximum size of a string is 1 KB.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludePattern<String[]>

Specifies an array of pattern strings that can include * and ? as wildcard characters. The maximum size of a string is 1 KB.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of file groups.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

true

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

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

Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileGroup

Examples

Example 1: Change the include pattern of a file group

This command changes the file group named "Media Files". After the cmdlet runs, the file group includes only files whose name ends in mp3 or wmv.


PS C:\> Set-FsrmFileGroup -Name "Media Files" -IncludePattern @("*.mp3", "*.wmv")

Example 2: Change the include pattern of a file group by using an object variable

This example changes the file group named "Media Files". After the cmdlet runs, the file group also includes .wma files.


 

The first command gets the file group named "Media Files" and stored the results in the variable $Group.


PS C:\> $Group = Get-FsrmFileGroup "Media Files"

 

The second command specifies an include pattern that includes .wma files for the file group stored in the variable $Group. The command stores the result in the $list variable.


PS C:\> $list = $Group.IncludePattern + "*.wma"

 

The third command sets the include pattern for the file group named "Media Files" to the include pattern stored in the variable $list.


PS C:\> Set-FsrmFileGroup -Name "Media Files" -IncludePattern $list

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft