Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Set-CMClientSettingRemoteTool

Sets a client setting remote tool.

Syntax

SetCustomSettingByName (Default)

Set-CMClientSettingRemoteTool
 -Name <String>
 [-AccessLevel <AccessLevelType>]
 [-AllowClientChange <Boolean>]
 [-AllowPermittedViewer <Boolean>]
 [-AllowUnattendedComputer <Boolean>]
 [-AudibleSignal <AudibleSignalType>]
 [-FirewallExceptionProfile <FirewallExceptionProfileType[]>]
 [-GrantPermissionToLocalAdministrator <Boolean>]
 [-ManageRemoteDesktopSetting <Boolean>]
 [-ManageSolicitedRemoteAssistance <Boolean>]
 [-ManageUnsolicitedRemoteAssistance <Boolean>]
 [-PermittedViewer <String[]>]
 [-PromptUserForClipboardPermission <Boolean>]
 [-PromptUserForPermission <Boolean>]
 [-RemoteAssistanceAccessLevel <RemoteAssistanceAccessLevelType>]
 [-RequireAuthentication <Boolean>]
 [-ShowNotificationIconOnTaskbar <Boolean>]
 [-ShowSessionConnectionBar <Boolean>]
 [-PassThru]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

SetDefaultSetting

Set-CMClientSettingRemoteTool
 [-AccessLevel <AccessLevelType>]
 [-AllowClientChange <Boolean>]
 [-AllowPermittedViewer <Boolean>]
 [-AllowUnattendedComputer <Boolean>]
 [-AudibleSignal <AudibleSignalType>]
 [-FirewallExceptionProfile <FirewallExceptionProfileType[]>]
 [-GrantPermissionToLocalAdministrator <Boolean>]
 [-ManageRemoteDesktopSetting <Boolean>]
 [-ManageSolicitedRemoteAssistance <Boolean>]
 [-ManageUnsolicitedRemoteAssistance <Boolean>]
 [-PermittedViewer <String[]>]
 [-PromptUserForClipboardPermission <Boolean>]
 [-PromptUserForPermission <Boolean>]
 [-RemoteAssistanceAccessLevel <RemoteAssistanceAccessLevelType>]
 [-RequireAuthentication <Boolean>]
 [-ShowNotificationIconOnTaskbar <Boolean>]
 [-ShowSessionConnectionBar <Boolean>]
 [-DefaultSetting]
 [-PassThru]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

SetCustomSettingByValue

Set-CMClientSettingRemoteTool
 -InputObject <IResultObject>
 [-AccessLevel <AccessLevelType>]
 [-AllowClientChange <Boolean>]
 [-AllowPermittedViewer <Boolean>]
 [-AllowUnattendedComputer <Boolean>]
 [-AudibleSignal <AudibleSignalType>]
 [-FirewallExceptionProfile <FirewallExceptionProfileType[]>]
 [-GrantPermissionToLocalAdministrator <Boolean>]
 [-ManageRemoteDesktopSetting <Boolean>]
 [-ManageSolicitedRemoteAssistance <Boolean>]
 [-ManageUnsolicitedRemoteAssistance <Boolean>]
 [-PermittedViewer <String[]>]
 [-PromptUserForClipboardPermission <Boolean>]
 [-PromptUserForPermission <Boolean>]
 [-RemoteAssistanceAccessLevel <RemoteAssistanceAccessLevelType>]
 [-RequireAuthentication <Boolean>]
 [-ShowNotificationIconOnTaskbar <Boolean>]
 [-ShowSessionConnectionBar <Boolean>]
 [-PassThru]
 [-DisableWildcardHandling]
 [-ForceWildcardHandling]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

PS XYZ:\>

Parameters

-AccessLevel

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:AccessLevelType
Default value:None
Accepted values:NoAccess, ViewOnly, FullControl
Supports wildcards:False
DontShow:False

Parameter sets

-AllowClientChange

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-AllowPermittedViewer

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AllowPermittedViewersToRemoteDesktop

Parameter sets

-AllowUnattendedComputer

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AllowRemoteControlOfUnattendedComputer

Parameter sets

-AudibleSignal

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:AudibleSignalType
Default value:None
Accepted values:PlayNoSound, PlaySoundAtBeginAndEnd, PlaySoundRepeatedly
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultSetting

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-FirewallExceptionProfile

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:

FirewallExceptionProfileType[]

Default value:None
Accepted values:Disabled, Public, Private, Domain
Supports wildcards:False
DontShow:False

Parameter sets

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-GrantPermissionToLocalAdministrator

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:GrantRemoteControlPermissionToLocalAdministrator

Parameter sets

-InputObject

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ManageRemoteDesktopSetting

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ManageSolicitedRemoteAssistance

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ManageUnsolicitedRemoteAssistance

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PassThru

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PermittedViewer

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:PermittedViewers

Parameter sets

-PromptUserForClipboardPermission

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PromptUserForClipboardAccessPermission

Parameter sets

-PromptUserForPermission

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PromptUserForRemoteControlPermission

Parameter sets

-RemoteAssistanceAccessLevel

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:RemoteAssistanceAccessLevelType
Default value:None
Accepted values:None, RemoteViewing, FullControl
Supports wildcards:False
DontShow:False

Parameter sets

-RequireAuthentication

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ShowNotificationIconOnTaskbar

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ShowSessionConnectionBar

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object


Feedback

Was this page helpful?