Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-NetConnectionProfile

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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[]
Parameter Sets: (All)
Aliases: 
Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: 
Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet

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

-InterfaceAlias

Specifies an array of names of network adapters.

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InterfaceIndex

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

Type: UInt32[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

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

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
  • Private
  • DomainAuthenticated
Type: NetworkCategory[]
Parameter Sets: (All)
Aliases: 
Accepted values: Public, Private, DomainAuthenticated

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Set-NetConnectionProfile

© 2017 Microsoft