< Back
Get-NsxController
Post
NAME Get-NsxController
SYNOPSIS
Retrieves NSX Controllers.
SYNTAX
Get-NsxController [[-ObjectId] <String>] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX Controller is a member of the NSX Controller Cluster, and forms the
highly available distributed control plane for NSX Logical Switching and NSX
Logical Routing.
The Get-NsxController cmdlet deploys a new NSX Controller via the NSX API.
PARAMETERS
-ObjectId <String>
ObjectId of the NSX Controller to return.
Required? false
Position? 2
Default value
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-NsxController
Retrieves all controller objects from NSX manager
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxController -objectId Controller-1
Returns a specific NSX Controller object from NSX manager
RELATED LINKS
SYNOPSIS
Retrieves NSX Controllers.
SYNTAX
Get-NsxController [[-ObjectId] <String>] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
An NSX Controller is a member of the NSX Controller Cluster, and forms the
highly available distributed control plane for NSX Logical Switching and NSX
Logical Routing.
The Get-NsxController cmdlet deploys a new NSX Controller via the NSX API.
PARAMETERS
-ObjectId <String>
ObjectId of the NSX Controller to return.
Required? false
Position? 2
Default value
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-NsxController
Retrieves all controller objects from NSX manager
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxController -objectId Controller-1
Returns a specific NSX Controller object from NSX manager
RELATED LINKS