Set-FsrmAdrSetting

Set-FsrmAdrSetting

Changes configuration settings for access denied remediation.

Syntax

Parameter Set: Query (cdxml)
Set-FsrmAdrSetting [-Event] <FsrmAdrEventEnum[]> [-AllowRequests] [-AsJob] [-CimSession <CimSession[]> ] [-DeviceTroubleshooting] [-DisplayMessage <String> ] [-EmailMessage <String> ] [-Enabled] [-EventLog] [-IncludeDeviceClaims] [-IncludeUserClaims] [-MailCCAdmin] [-MailTo <String> ] [-MailToOwner] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-FsrmAdrSetting -InputObject <CimInstance[]> [-AllowRequests] [-AsJob] [-CimSession <CimSession[]> ] [-DeviceTroubleshooting] [-DisplayMessage <String> ] [-EmailMessage <String> ] [-Enabled] [-EventLog] [-IncludeDeviceClaims] [-IncludeUserClaims] [-MailCCAdmin] [-MailTo <String> ] [-MailToOwner] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-FsrmAdrSetting cmdlet changes configuration settings for access denied remediation (ADR) for one or more events. The File Server Resource Manager (FSRM) uses the ADR settings when a client cannot access a file. Users get an access-denied message when they try to access shared files and folders on a file server for which they do not have permissions.

Parameters

-AllowRequests

Indicates that users can request access by sending email.

-AsJob

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

-DeviceTroubleshooting

Indicates that Windows shows the user the device claims in the access-denied message.

-DisplayMessage<String>

Specifies the message that the file server displays to the user when the server receives the event. The length of the string must not exceed 10KB.

-EmailMessage<String>

Specifies the email message that the file server sends to the user when the server receives the event. The length of the string must not exceed 10KB.

-Enabled

Indicates that remediation is enabled for events on this server.

-Event<FsrmAdrEventEnum[]>

Specifies an array of types of events that ADR handles. The acceptable values for this parameter are: AccessDenied and FileNotFound.

-EventLog

Indicates that the server creates an Event Log entry for each access request email that the file server sends.

-IncludeDeviceClaims

Indicates that the file server includes device claims when a user requests access.

-IncludeUserClaims

Indicates that the file server includes user claims when a user requests access.

-InputObject<CimInstance[]>

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

-MailCCAdmin

Indicates that the file server includes the system administrator on the CC line of the email message when a user requests access.

-MailTo<String>

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

-MailToOwner

Indicates that the file server emails the data owner when a user requests access.

-PassThru

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

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

Examples

Example 1: Change ADR settings for an event

This command changes ADR settings for the AccessDenied event. The command enables remediation for the AccessDenied event, specifies the display message and email message for the event, and indicates that users can request access by sending email.

PS C:\> Set-FsrmAdrSetting -Event AccessDenied -Enabled -DisplayMessage "Access to file is denied" -EmailMessage "Access to file is denied. You can email a request for permission to access the file." -AllowRequests -MailToOwner:$false -MailCCAdmin -MailTo "john@contoso.com" -IncludeDeviceClaims -IncludeUserClaims -EventLog –DeviceTroubleShooting

Related topics

Get-FsrmAdrSetting