< Back
Get-NsxTransportZone
Post
NAME Get-NsxTransportZone
SYNOPSIS
Retrieves a TransportZone object.
SYNTAX
Get-NsxTransportZone [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [[-name] <String>] -LocalOnly [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [[-name] <String>] -UniversalOnly [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [-name] <String> [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone -objectId <String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Transport Zones are used to control the scope of logical switches within
NSX. A Logical Switch is 'bound' to a transport zone, and only hosts that
are members of the Transport Zone are able to host VMs connected to a
Logical Switch that is bound to it. All Logical Switch operations require a
Transport Zone.
PARAMETERS
-name <String>
TransportZoneName
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-objectId <String>
NSX ObjectId
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalOnly [<SwitchParameter>]
Return only Universal objects
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Return only Locally scoped objects
Required? true
Position? named
Default value False
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-NsxTransportZone -name TestTZ
Get the NSX Transport Zone named "TestTZ"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxTransportZone -LocalOnly
Get all Local NSX Transport Zones configured
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxTransportZone -UniversalOnly
Get all Universal NSX Transport Zones configured
RELATED LINKS
SYNOPSIS
Retrieves a TransportZone object.
SYNTAX
Get-NsxTransportZone [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [[-name] <String>] -LocalOnly [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [[-name] <String>] -UniversalOnly [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone [-name] <String> [-Connection <PSObject>] [<CommonParameters>]
Get-NsxTransportZone -objectId <String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Transport Zones are used to control the scope of logical switches within
NSX. A Logical Switch is 'bound' to a transport zone, and only hosts that
are members of the Transport Zone are able to host VMs connected to a
Logical Switch that is bound to it. All Logical Switch operations require a
Transport Zone.
PARAMETERS
-name <String>
TransportZoneName
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-objectId <String>
NSX ObjectId
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalOnly [<SwitchParameter>]
Return only Universal objects
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LocalOnly [<SwitchParameter>]
Return only Locally scoped objects
Required? true
Position? named
Default value False
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-NsxTransportZone -name TestTZ
Get the NSX Transport Zone named "TestTZ"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxTransportZone -LocalOnly
Get all Local NSX Transport Zones configured
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxTransportZone -UniversalOnly
Get all Universal NSX Transport Zones configured
RELATED LINKS