Get-NetConnectionProfile

Get-NetConnectionProfile

Gets a connection profile.

Syntax

Parameter Set: Query (cdxml)
Get-NetConnectionProfile [-AsJob] [-CimSession <CimSession[]> ] [-InterfaceAlias <String[]> ] [-InterfaceIndex <UInt32[]> ] [-IPv4Connectivity <IPv4Connectivity[]> ] [-IPv6Connectivity <IPv6Connectivity[]> ] [-Name <String[]> ] [-NetworkCategory <NetworkCategory[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetConnectionProfile cmdlet gets a connection profile associated with one or more physical network adapters. A connection profile represents a network connection.

Parameters

-AsJob

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

-InterfaceAlias<String[]>

Specifies an array of names of network adapters.

-InterfaceIndex<UInt32[]>

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

-IPv4Connectivity<IPv4Connectivity[]>

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

-IPv6Connectivity<IPv6Connectivity[]>

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

-Name<String[]>

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

-NetworkCategory<NetworkCategory[]>

Specifies an array of category types of a network. The acceptable values for this parameter are:
-- Public
-- Private
-- DomainAuthenticated

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

<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: Get a connection profile

This first part of this command gets the connection profile for the network adapter named Ethernet1. The command passes the results to the Set-NetConnectionProfile cmdlet by using the pipe operator. The second part of the command changes the value of the network category for the connection profile.

PS C:\> Get-NetConnectionProfile -InterfaceAlias "Ethernet1" | Set-NetConnectionProfile -NetworkCategory Public

Related topics

Set-NetConnectionProfile