< Back
Clear-NsxEdgeInterface
Post
NAME Clear-NsxEdgeInterface
SYNOPSIS
Clears the configuration on an NSX Edge Services Gateway interface.
SYNTAX
Clear-NsxEdgeInterface [-Interface] <XmlElement> [-Confirm] [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
NSX ESGs can host up to 10 interfaces and up to 200 subinterfaces, each of which
can be configured with multiple properties.
ESGs support itnerfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use Clear-NsxEdgeInterface to set the configuration of an interface back to default
(disconnected, not attached to any portgroup, and no defined addressgroup).
PARAMETERS
-Interface <XmlElement>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 2
Default value $defaultNSXConnection
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get an interface and then clear its configuration.
PS C:\\> $interface = Get-NsxEdge $name | Get-NsxEdgeInterface "vNic4"
PS C:\\> $interface | Clear-NsxEdgeInterface -confirm:$false
RELATED LINKS
SYNOPSIS
Clears the configuration on an NSX Edge Services Gateway interface.
SYNTAX
Clear-NsxEdgeInterface [-Interface] <XmlElement> [-Confirm] [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
NSX ESGs can host up to 10 interfaces and up to 200 subinterfaces, each of which
can be configured with multiple properties.
ESGs support itnerfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use Clear-NsxEdgeInterface to set the configuration of an interface back to default
(disconnected, not attached to any portgroup, and no defined addressgroup).
PARAMETERS
-Interface <XmlElement>
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 2
Default value $defaultNSXConnection
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get an interface and then clear its configuration.
PS C:\\> $interface = Get-NsxEdge $name | Get-NsxEdgeInterface "vNic4"
PS C:\\> $interface | Clear-NsxEdgeInterface -confirm:$false
RELATED LINKS