Disable-NetworkSwitchEthernetPort

NAME Disable-NetworkSwitchEthernetPort



SYNOPSIS

Disables an Ethernet port on a network switch.





SYNTAX

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

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



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

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



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

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





DESCRIPTION

The Disable-NetworkSwitchEthernetPort cmdlet disables an Ethernet port on 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 disables a port on a device that this parameter specifies.



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



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

CimInstance[]



You can pipe an array of CimInstance objects that correspond to an Ethernet port to this cmdlet.





OUTPUTS

None



This cmdlet does not generate any output.





Example 1: Disable a port



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

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



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.



This command disables port 21 for NetworkSwitch08 by using the $Session object.





Example 2: Disable a port by using a device ID



PS C:\\>Disable-NetworkSwitchEthernetPort -CimSession $Session -DeviceId "Ethernet17"



This command disables an Ethernet port with device ID Ethernet17 on a network switch. The command uses a CimSession, similar to the first example.







RELATED LINKS

Enable-NetworkSwitchEthernetPort

Get-NetworkSwitchEthernetPort