Edit

Get-NetConnectionProfile

  • Reference
Module:
NetConnection

Gets a connection profile.

Syntax

Get-NetConnectionProfile
   [-Name <String[]>]
   [-InterfaceAlias <String[]>]
   [-InterfaceIndex <UInt32[]>]
   [-NetworkCategory <NetworkCategory[]>]
   [-IPv4Connectivity <IPv4Connectivity[]>]
   [-IPv6Connectivity <IPv6Connectivity[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get a connection profile

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

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.

Parameters

-AsJob

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.

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

-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 NNew-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceAlias

Specifies an array of names of network adapters.

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

-InterfaceIndex

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

Type:UInt32[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-IPv4Connectivity

Specifies an array of IPv4 protocol connectivity status values. The acceptable values for this parameter are:

  • Disconnected
  • NoTraffic
  • Subnet
  • LocalNetwork
  • Internet
Type:IPv4Connectivity[]
Accepted values:Disconnected, NoTraffic, Subnet, LocalNetwork, Internet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IPv6Connectivity

Specifies an array of IPv6 protocol connectivity status values. The acceptable values for this parameter are:

  • Disconnected
  • NoTraffic
  • Subnet
  • LocalNetwork
  • Internet
Type:IPv6Connectivity[]
Accepted values:Disconnected, NoTraffic, Subnet, LocalNetwork, Internet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

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

-NetworkCategory

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

  • Public - Networks in a public place such as an airport or coffee shop. Your PC is hidden from other devices on the network and can't be used for printer and file sharing.
  • Private - Networks at home or work, where you know and trust the people and devices on the network. Your PC is discoverable and can be used for printer and file sharing if you set it up.
  • DomainAuthenticated - Networks at a workplace that are joined to a domain.
Type:NetworkCategory[]
Accepted values:Public, Private, DomainAuthenticated
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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