Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetConnectionProfile

Set-NetConnectionProfile

msft_netconnectionprofile.cdxml

Synopsis

Changes the network category of a connection profile.

Syntax

Set-NetConnectionProfile [-AsJob] [-CimSession] [-InterfaceAlias] [-InterfaceIndex] [-IPv4Connectivity] [-IPv6Connectivity] [-Name] [-NetworkCategory] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetConnectionProfile [-AsJob] [-CimSession] [-NetworkCategory] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetConnectionProfile cmdlet changes the network category setting of a connection profile. A connection profile represents a network connection.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-InterfaceAlias <String[]>

Specifies an array of names of network adapters.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InterfaceIndex <UInt32[]>

Specifies an array of numerical index values associated with the network adapters.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-IPv4Connectivity <IPv4Connectivity[]>

Specifies an array of IPv4 protocol connectivity status values. The acceptable values for this parameter are:  -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IPv6Connectivity <IPv6Connectivity[]>

Specifies an array of IPv6 protocol connectivity status values. The acceptable values for this parameter are:  -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies an array of names of networks with which the connection is currently established.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NetworkCategory <NetworkCategory>

Specifies an array of category types of a network. You cannot set the DomainAuthenticated type by using this cmdlet. The server automatically sets the value of DomainAuthenticated when the network is authenticated to a domain controller. The acceptable values for this parameter are:  -- Public -- Private

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Change the network category of a connection profile

This example changes the network category of a connection profile.

This first command gets the connection profile for the network adapter named Ethernet1. The command stores the results in the $Profile variable.
PS C:\>$Profile = Get-NetConnectionProfile -InterfaceAlias Ethernet1

This second command assigns the value of Public to the NetworkCategory property of the connection profile stored in the $Profile variable.
PS C:\>$Profile.NetworkCategory = Public

This third command sets the network category of the connection profile stored in the $Profile variable.
PS C:\>Set-NetConnectionProfile -InputObject $Profile

Online Version
Get-NetConnectionProfile