Get-NetworkSwitchEthernetPort
Gets port information for a network switch.
Syntax
DeviceIDSet (Default)
Get-NetworkSwitchEthernetPort
-CimSession <CimSession>
[-DeviceId <String>]
[<CommonParameters>]
FullDuplexEnabledSet
Get-NetworkSwitchEthernetPort
-CimSession <CimSession>
[-FullDuplexEnabled]
[<CommonParameters>]
FullDuplexDisabledSet
Get-NetworkSwitchEthernetPort
-CimSession <CimSession>
[-FullDuplexDisabled]
[<CommonParameters>]
PortNumberSet
Get-NetworkSwitchEthernetPort
-CimSession <CimSession>
-PortNumber <Int32>
[<CommonParameters>]
Description
The Get-NetworkSwitchEthernetPort cmdlet gets port information for a network switch.
Examples
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.
Parameters
-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
.
Parameter properties
Type: | CimSession |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-DeviceId
Specifies a device ID. This cmdlet gets information for the port that this parameter specifies.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
DeviceIDSet
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-FullDuplexDisabled
Indicates that this cmdlet returns only ports that have FullDuplex disabled.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
FullDuplexDisabledSet
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-FullDuplexEnabled
Indicates that this cmdlet returns only ports that have FullDuplex enabled.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
FullDuplexEnabledSet
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-PortNumber
Specifies a port number. This cmdlet gets the port that the parameter specifies.
Parameter properties
Type: | Int32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
PortNumberSet
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.