Set-CMRemoteConnectionProfileConfigurationItem
Set-CMRemoteConnectionProfileConfigurationItem
Modifies a remote connection profile.
Syntax
Parameter Set: SetByName
Set-CMRemoteConnectionProfileConfigurationItem -Name <String[]> [-Description <String> ] [-EnableNLA <Boolean> ] [-EnablePrimaryUsers <Boolean> ] [-EnableTSConnection <Boolean> ] [-EnableTSFirewallRule <Boolean> ] [-NewName <String> ] [-RDGatewayServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetById
Set-CMRemoteConnectionProfileConfigurationItem -Id <String[]> [-Description <String> ] [-EnableNLA <Boolean> ] [-EnablePrimaryUsers <Boolean> ] [-EnableTSConnection <Boolean> ] [-EnableTSFirewallRule <Boolean> ] [-NewName <String> ] [-RDGatewayServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetByValue
Set-CMRemoteConnectionProfileConfigurationItem -InputObject <IResultObject> [-Description <String> ] [-EnableNLA <Boolean> ] [-EnablePrimaryUsers <Boolean> ] [-EnableTSConnection <Boolean> ] [-EnableTSFirewallRule <Boolean> ] [-NewName <String> ] [-RDGatewayServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
Parameters
-Description<String>
Specifies a description for a remote connection profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableNLA<Boolean>
Indicates whether to allow connections only from computers that run Remote Desktop by using Network Level Authentication.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnablePrimaryUsers<Boolean>
Indicates whether all primary users of the client computer are allowed to remotely connect. If you specify a value for this parameter, you must specify values for the EnableTSConnection and EnableTSFirewallRule parameters.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableTSConnection<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-EnableTSFirewallRule<Boolean>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Id<String[]>
Specifies an array of IDs for remote connection profiles.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a remote connection profile object. To obtain a remote connection profile, use the Get-CMRemoteConnectionProfileConfigurationItem cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names of remote connection profiles.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies the new name for the remote connection profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RDGatewayServer<String>
Specifies the host name and port of the Remote Desktop gateway server, for example, Boston.gateway.Contoso.com:8080.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Examples
Example 1: Modify a remote connection profile configuration item
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.
PS C:\> Set-CMRemoteConnectionProfileConfigurationItem -ID "AAA0004D" -EnablePrimaryUsers $False -EnableTSConnection $False -EnableTSFirewallRule $False
Related topics
Copy-CMRemoteConnectionProfileConfigurationItem
Get-CMRemoteConnectionProfileConfigurationItem