Set-FsrmFileManagementJob

Set-FsrmFileManagementJob

Changes configuration settings of a file management job.

Syntax

Parameter Set: Query (cdxml)
Set-FsrmFileManagementJob [-Name] <String[]> [-Action <CimInstance> ] [-AsJob] [-CimSession <CimSession[]> ] [-Condition <CimInstance[]> ] [-Continuous] [-ContinuousLog] [-ContinuousLogSize <UInt64> ] [-Description <String> ] [-Disabled] [-MailTo <String> ] [-Namespace <String[]> ] [-Notification <CimInstance[]> ] [-Parameters <String[]> ] [-PassThru] [-ReportFormat <FmjReportFormatsEnum[]> ] [-ReportLog <FmjReportLogsEnum[]> ] [-Schedule <CimInstance> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-FsrmFileManagementJob -InputObject <CimInstance[]> [-Action <CimInstance> ] [-AsJob] [-CimSession <CimSession[]> ] [-Condition <CimInstance[]> ] [-Continuous] [-ContinuousLog] [-ContinuousLogSize <UInt64> ] [-Description <String> ] [-Disabled] [-MailTo <String> ] [-Namespace <String[]> ] [-Notification <CimInstance[]> ] [-Parameters <String[]> ] [-PassThru] [-ReportFormat <FmjReportFormatsEnum[]> ] [-ReportLog <FmjReportLogsEnum[]> ] [-Schedule <CimInstance> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-FsrmFileManagementJob cmdlet changes configuration settings of a file management job. You must specify at least one other parameter in addition to the Name parameter.

Parameters

-Action<CimInstance>

Specifies a FsrmFmjAction object. You can use the New-FsrmFmjAction cmdlet to create a FsrmFmjAction object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-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

-Condition<CimInstance[]>

Specifies a FsrmFmjCondition object. You can use the New-FsrmFmjCondition cmdlet to create a FsrmFmjCondition object.

Aliases	none
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.

If you specify this parameter, you cannot specify any notifications and the conditions that you specify cannot include any objects where the classification property is set to the following values:
-- File.DateCreated
-- File.DateLastModified
-- File.DateLastAccessed

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

-Description<String>

Specifies a description for the file management job.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Disabled

Indicates that the file management job is disabled.

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

-MailTo<String>

Specifies a semicolon-separated list of email addresses to which the file server sends the email.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Name<String[]>

Specifies a name for the file management job.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	true

-Namespace<String[]>

Specifies an array of namespaces that are part of the scope. Each value must be either a value of the FolderType property defined on the server (in the format "[Folder type property name=<value>]") or a static path.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Notification<CimInstance[]>

Specifies a FsrmFmjNotificationAction object. You can use the New-FsrmFmjNotificationAction cmdlet to create a FsrmFmjNotificationAction object.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Parameters<String[]>

Specifies an array of strings using the format <name>=<value>. The File Classification Infrastructure and other management tools use these parameters.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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

-ReportFormat<FmjReportFormatsEnum[]>

Specifies an array of report formats that the file management job produces. The acceptable values for this parameter are:
-- DHTML
-- HTML
-- XML
-- CSV
-- Text

Aliases	none
Required?	false
Position?	named
Default Value	{"DHTML", "XML"}
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ReportLog<FmjReportLogsEnum[]>

Specifies an array of report types that the file management job generates. The acceptable values for this parameter are:
-- Information
-- Error
-- Audit

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. Any duration information in the FSRM scheduled task object is ignored.

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_FSRMFileManagementJob

Examples

Example 1: Change the condition for a file management job

This example changes the file management job named Expire stale data to include only files that have the PII property set to true in addition to the existing conditions.

The first command returns a condition object for file management job that verifies that a file has a PII classification property set to true. The command stores the results in the $condition variable.

PS C:\> $condition = New-FsrmFmjCondition -Property "PII" -Condition Equal -Value "1"

The second command gets the file management job named "Expire stale data" and stores the results in the $current variable.

PS C:\> $current = Get-FsrmFileManagementJob -Name "Expire stale data"

The third command adds the new condition to the existing conditions of the file management job.

PS C:\> $newConditions = $current.Conditions + $condition

The fourth command sets the condition of the file management job named "Expire stale data" to the condition stored in the $newConditions variable.

PS C:\> Set-FsrmFileManagementJob "Expire stale data" -Condition $newConditions

Related topics

Get-FsrmFileManagementJob

New-FsrmFileManagementJob

Remove-FsrmFileManagementJob

Start-FsrmFileManagementJob

Stop-FsrmFileManagementJob

Wait-FsrmFileManagementJob

New-FsrmScheduledTask

New-FsrmFmjCondition

New-FsrmFmjNotificationAction