Edit

New-FsrmFMJNotification

  • Reference
Module:
FileServerResourceManager

Returns a notification object for file management jobs.

Syntax

New-FsrmFMJNotification
   [-Days] <UInt32>
   [-Action <CimInstance[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-Confirm]
   [-WhatIf]

Description

The New-FsrmFMJNotification cmdlet returns a notification object that you can use to create file management job actions. You can use the FsrmFMJNotification object as input for the New-FsrmFileManagementJob cmdlet and the Set-FsrmFileManagementJob cmdlet.

The FsrmFmjAction object defines a notification period before a file management job acts on a file. This cmdlet supports the following actions:

  • Email
  • Event
  • Command

Examples

Example 1: Create a notification for file management jobs

PS C:\>$action = New-FsrmFmjNotificationAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: Files will expire soon" -Body "The attached list of files will expire in 30 days." -AttachmentFileListSize 1000 PS C:\>New-FsrmFmjNotification -Days 30 -Action $action

The first command returns an object that represents a notification action. The notification action sends the specified email message to the administrator and file owner, and specifies that the action can attach a maximum of 1000 files to the message. The command stores the notification action object in the $action variable.

The second command returns a notification object for a file management job that runs the notification action stored in the $action variable 30 days before the file management job acts.

Parameters

-Action

Specifies an array of file management job actions. You can create a job action by using the New-FsrmFmjAction cmddlet.

Type:CimInstance[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-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

-Days

Specifies the number of days before a file management job acts on a file to run the notification action.

Type:UInt32
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-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

Outputs

CimInstance