Set-NetConnectionProfile is a Windows PowerShell command used to configure the network connection profile for a network adapter. It is part of the NetAdapter module, which provides a set of cmdlets for managing network adapters and their associated settings. With Set-NetConnectionProfile, you can configure the network connection profile for a network adapter, including the network type, the network authentication type, and the network encryption type.
Set-NetConnectionProfile is an important tool for network administrators, as it allows them to quickly and easily configure the network connection profile for a network adapter. This can be especially useful when setting up a new network, or when troubleshooting an existing network.
Syntax
The syntax for the Set-NetConnectionProfile command is as follows:
Set-NetConnectionProfile [-Name] <String> [-NetworkCategory <String>] [-NetworkAuthentication <String>] [-NetworkEncryption <String>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
Parameters
The Set-NetConnectionProfile command has the following parameters:
Parameter | Description |
---|---|
-Name |
Specifies the name of the network connection profile to configure. |
-NetworkCategory |
Specifies the network type of the network connection profile. Valid values are: Public, Private, or DomainAuthenticated. |
-NetworkAuthentication |
Specifies the network authentication type of the network connection profile. Valid values are: Open, Shared, WPA, WPA2, WPA2PSK, WPA2Enterprise, or WPA3. |
-NetworkEncryption |
Specifies the network encryption type of the network connection profile. Valid values are: AES, TKIP, or WEP. |
-PassThru |
Returns the object representing the modified network connection profile. |
-CimSession |
Specifies the CIM session to use for the operation. |
-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. |
-AsJob |
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. |
-WhatIf |
Shows what would happen if the cmdlet runs. The cmdlet is not run. |
-Confirm |
Prompts you for confirmation before running the cmdlet. |
Inputs
The Set-NetConnectionProfile command accepts the following input types:
- System.String
- System.Management.Automation.CimSession
- System.Management.Automation.PSCredential
Outputs
The Set-NetConnectionProfile command produces the following output types:
- Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetConnectionProfile
Examples
The following example shows how to use the Set-NetConnectionProfile command to configure the network connection profile for a network adapter:
Set-NetConnectionProfile -Name "MyNetworkAdapter" -NetworkCategory Private -NetworkAuthentication WPA2 -NetworkEncryption AES
This example configures the network connection profile for the network adapter named “MyNetworkAdapter” with the network type set to Private, the network authentication type set to WPA2, and the network encryption type set to AES.
Tips
Here are some tips for using the Set-NetConnectionProfile command:
- Make sure to specify the correct network type, authentication type, and encryption type for the network connection profile.
- If you are unsure of the correct values for the network type, authentication type, and encryption type, consult your network administrator.
- If you are configuring the network connection profile for a wireless network adapter, make sure that the authentication type and encryption type match the settings of the wireless access point.
- Use the
-PassThru
parameter to return the object representing the modified network connection profile. - Use the
-AsJob
parameter to run the command as a background job. - Use the
-WhatIf
and-Confirm
parameters to test the command before running it.
Conclusion
Set-NetConnectionProfile is a powerful Windows PowerShell command that allows you to quickly and easily configure the network connection profile for a network adapter. With Set-NetConnectionProfile, you can configure the network type, authentication type, and encryption type for a network adapter, making it an essential tool for network administrators.