Set-FsrmClassification

Set-FsrmClassification

Changes configuration settings for classification.

Syntax

Parameter Set: InputObject (cdxml)
Set-FsrmClassification [-AsJob] [-CimSession <CimSession[]> ] [-Continuous] [-ContinuousLog] [-ContinuousLogSize <UInt64> ] [-ExcludeNamespace <String[]> ] [-InputObject <CimInstance[]> ] [-PassThru] [-Schedule <CimInstance> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-FsrmClassification cmdlet changes configuration settings for classification.

Parameters

-AsJob

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

-Continuous

Indicates that the server continuously applies classification to files in the background.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ContinuousLog

Indicates that the server maintains a log of continuous classification activities. You must specify the Continuous parameter to log classification activities.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ContinuousLogSize<UInt64>

Specifies the maximum size of the log that contains continuous classification activity. You must specify the Continuous parameter to log classification activities.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ExcludeNamespace<String[]>

Specifies an array of strings that contain the list of folders to not include in classification (scheduled or continuous).

You can include [AllVolumes] in each folder at the start of a path to indicate that the namespace is excluded on all volumes. You can append the string /s to each namespace to exclude all folders and files in that namespace. If /s is not appended to the namespace, only the files in the specified folder are excluded. If one string is [Default], the server adds the default values to the exclude namespaces. The boot volume is always excluded regardless of this value.

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?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-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

-Schedule<CimInstance>

Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for performing the continuous classification. Use the New-FsrmScheduledTask cmdlet to create a scheduled task object.

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 (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.

Outputs

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

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassification

Examples

Example 1: Set classification to run continuously

This command sets classification to run continuously and enables the continuous classification log. If you have not previously created a classification schedule, the command results in an error.

PS C:\> Set-FsrmClassification –Continuous -ContinuousLog

Example 2: Set the schedule for classification

This example sets the schedule for classification to run once a month on the first day at midnight.

The first command gets a DateTime object and stores it in the variable $d.

PS C:\> $d = Get-Date "12:00am"

The second command creates a FsrmScheduledTask object that defines a schedule for the task of once a month on the first day of the month at midnight. The command stores the FsrmScheduledTask object in the $task variable.

PS C:\> $task = New-FsrmScheduledTask -Time $d.ToFileTimeUtc() -Monthly 1

The third command sets the schedule for classification to the schedule stored in the $task variable.

PS C:\> Set-FsrmClassification -Schedule $task

Get-FsrmClassification

Start-FsrmClassification

Stop-FsrmClassification

Wait-FsrmClassification

New-FsrmScheduledTask