Set-CMRemoteConnectionProfileConfigurationItem

Reference

Module:: ConfigurationManager

Modifies a remote connection profile.

Syntax

Set-CMRemoteConnectionProfileConfigurationItem
   [-Enable <Boolean>]
   [-EnableNla <Boolean>]
   [-EnablePrimaryUser <Boolean>]
   [-EnableTSConnection <Boolean>]
   [-EnableTSFirewallRule <Boolean>]
   [-InputObject] <IResultObject>
   [-RDGatewayServer <String>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-NewName <String>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMRemoteConnectionProfileConfigurationItem
   [-Enable <Boolean>]
   [-EnableNla <Boolean>]
   [-EnablePrimaryUser <Boolean>]
   [-EnableTSConnection <Boolean>]
   [-EnableTSFirewallRule <Boolean>]
   [-RDGatewayServer <String>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-Id] <Int32>
   [-NewName <String>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMRemoteConnectionProfileConfigurationItem
   [-Enable <Boolean>]
   [-EnableNla <Boolean>]
   [-EnablePrimaryUser <Boolean>]
   [-EnableTSConnection <Boolean>]
   [-EnableTSFirewallRule <Boolean>]
   [-RDGatewayServer <String>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-Name] <String>
   [-NewName <String>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMRemoteConnectionProfileConfigurationItem cmdlet modifies a remote connection profile. Client computers use remote connection profiles to remotely connect to computers from outside the ___domain or over the Internet.

Note

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

Examples

Example 1: Modify a remote connection profile configuration item

PS XYZ:\> Set-CMRemoteConnectionProfileConfigurationItem -ID "AAA0004D" -EnablePrimaryUsers $False -EnableTSConnection $False -EnableTSFirewallRule $False

This command modifies the remote connection profile configuration item with the ID AAA0004D. In this case, the EnablePrimaryUsers, EnableTSConnection, and EnableTSFirewallRule properties are all set to $False.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specifies a description for a remote connection profile.

Type:	String
Aliases:	LocalizedDescription
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Digest

Type:	ConfigurationItem
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DigestPath

Type:	String
Aliases:	DesiredConfigurationDigestPath
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DigestXml

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableWildcardHandling

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

Type:	Boolean
Aliases:	EnableConnectionSettings
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableNla

Indicates whether to allow connections only from computers that run Remote Desktop by using Network Level Authentication.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnablePrimaryUser

Type:	Boolean
Aliases:	EnablePrimaryUsers
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableTSConnection

Indicates whether to allow remote connections to client computers. If you specify a value for this parameter, you must specify values for the EnablePrimaryUsers and EnableTSFirewallRule parameters.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableTSFirewallRule

Indicates whether to allow Windows Firewall exceptions for connections in Windows domains and on private networks. If you specify a value for this parameter, you must specify values for the EnablePrimaryUsers and EnableTSConnections parameters.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ForceWildcardHandling

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies an array of IDs for remote connection profiles.

Type:	Int32
Aliases:	CIId, CI_ID
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies a remote connection profile object. To obtain a remote connection profile, use the Get-CMRemoteConnectionProfileConfigurationItem cmdlet.

Type:	IResultObject
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies an array of names of remote connection profiles.

Type:	String
Aliases:	LocalizedDisplayName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NewName

Specifies the new name for the remote connection profile.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RDGatewayServer

Specifies the host name and port of the Remote Desktop gateway server, for example, Boston.gateway.Contoso.com:8080.

Type:	String
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 doesn't run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Microsoft.ConfigurationManagement.DesiredConfigurationManagement.ConfigurationItem

Outputs

System.Object

New-CMRemoteConnectionProfileConfigurationItem

Share via