< Back

Get-NsxEdgeInterface

Sat Jan 18, 2020 9:03 pm

NAME Get-NsxEdgeInterface



SYNOPSIS

Retrieves the specified interface configuration on a specified Edge Services

Gateway.





SYNTAX

Get-NsxEdgeInterface -Edge <XmlElement> [[-Name] <String>] [-Connection <PSObject>] [<CommonParameters>]



Get-NsxEdgeInterface -Edge <XmlElement> -Index <Int32> [-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 interfaces connected to either VLAN backed port groups or NSX

Logical Switches.



Use Get-NsxEdgeInterface to retrieve the configuration of an interface.





PARAMETERS

-Edge <XmlElement>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Index <Int32>



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Connection <PSObject>

PowerNSX Connection object



Required? false

Position? named

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 all interface configuration for ESG named Edge01



PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeInterface









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get interface configuration for interface named vNic4 on ESG named Edge01



PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeInterface vNic4









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get interface configuration for interface number 4 on ESG named Edge01



PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeInterface -index 4











RELATED LINKS