< Back

Get-NetworkSwitchEthernetPort

Tue Jan 29, 2019 10:30 pm

NAME Get-NetworkSwitchEthernetPort



SYNOPSIS

Gets port information for a network switch.





SYNTAX

Get-NetworkSwitchEthernetPort [-DeviceId <String>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]

[-InformationVariable <System.String>] -CimSession <CimSession> [<CommonParameters>]



Get-NetworkSwitchEthernetPort [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable

<System.String>] -CimSession <CimSession> -FullDuplexEnabled [<CommonParameters>]



Get-NetworkSwitchEthernetPort [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable

<System.String>] -CimSession <CimSession> -FullDuplexDisabled [<CommonParameters>]



Get-NetworkSwitchEthernetPort [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable

<System.String>] -CimSession <CimSession> -PortNumber <Int32> [<CommonParameters>]





DESCRIPTION

The Get-NetworkSwitchEthernetPort cmdlet gets port information for a network switch.





PARAMETERS

-CimSession <CimSession>

Specifies the CimSession that this cmdlet uses to connect to the network switch. For more information about CimSession objects, type Get-Help

New-CimSession.



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-DeviceId [<String>]

Specifies a device ID. This cmdlet gets information for the port that this parameter specifies.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FullDuplexDisabled <SwitchParameter>

Indicates that this cmdlet returns only ports that have FullDuplex disabled.



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FullDuplexEnabled <SwitchParameter>

Indicates that this cmdlet returns only ports that have FullDuplex enabled.



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-InformationAction [<System.Management.Automation.ActionPreference>]

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:



-- SilentlyContinue

-- Stop

-- Continue

-- Inquire

-- Ignore

-- Suspend



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-InformationVariable [<System.String>]

Specifies a variable in which to store an information event message.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-PortNumber <Int32>

Specifies a port number. This cmdlet gets the port that the parameter specifies.



Required? true

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None









OUTPUTS

CimInstance[]



This cmdlet returns an array of CimInstance objects that correspond to Ethernet ports on a network switch.





Example 1: Get all the ports for a device



PS C:\\>$Session = New-CimSession -ComputerName "NetworkSwitch08"

PS C:\\> Get-NetworkSwitchEthernetPort -CimSession $Session



The first command creates a CimSession for a network switch, and then stores it in the $Session variable. For more information about CimSession

objects, type Get-Help New-CimSession.



The second command gets the ports for NetworkSwitch08 by using the $Session object.





Example 2: Get a specific port



PS C:\\>Get-NetworkSwitchEthernetPort -PortNumber 21 -CimSession $Session

Name PortNumber DeviceID FullDuplex AutoSense PortType MaxDataSize

---- ---------- -------- ---------- --------- -------- -----------

Ethernet17 21 Ethernet17 True False 0 9214



This command gets port 21. The example shows the console output for the command. The command includes a CimSession, similar to the first example.





Example 3: Get a port with a specified ID



PS C:\\>Get-NetworkSwitchEthernetPort -DeviceID "Ethernet17" -CimSession $Session



This command gets the port for the device that has the ID Ethernet17. The command includes a CimSession, similar to the first example.







RELATED LINKS

Disable-NetworkSwitchEthernetPort

Enable-NetworkSwitchEthernetPort