< Back
Set-NsxManagerRole
Post
NAME Set-NsxManagerRole
SYNOPSIS
Sets the NSX Manager Role.
SYNTAX
Set-NsxManagerRole [-Role] <String> [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
The NSX Manager is the central management component of VMware NSX for
vSphere.
The Set-NsxManagerRole cmdlet sets the universal sync role of the
NSX Manager against which the command is run.
The only state transitions that are allowed are Standalone (default) to
Primary, Secondary to Primary, Primary to StandAlone, or Secondary to
StandAlone.
This cmdlet does not configure a manager as the Secondary role.
To configure an NSX Manager as secondary, you must use
Add-NsxSecondaryManager against the Primary NSX Manager.
PARAMETERS
-Role <String>
New Role for connected NSX Manager
Required? true
Position? 1
Default value
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:\\>Set-NsxManagerRole -Role Primary
Sets the universal sync role to Primary for the connected NSX Manager
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-NsxManagerRole -Role StandAlone
Sets the universal sync role to Standalone for the connected NSX Manager.
Note, if running this against a manager that currently is configured as
secondary, and universal objects exist, then the state will transition to
TRANSIT rather than standalone. The may then be configured as PRIMARY, or
if all universal objects are deleted, as STANDALONE.
RELATED LINKS
SYNOPSIS
Sets the NSX Manager Role.
SYNTAX
Set-NsxManagerRole [-Role] <String> [[-Connection] <PSObject>] [<CommonParameters>]
DESCRIPTION
The NSX Manager is the central management component of VMware NSX for
vSphere.
The Set-NsxManagerRole cmdlet sets the universal sync role of the
NSX Manager against which the command is run.
The only state transitions that are allowed are Standalone (default) to
Primary, Secondary to Primary, Primary to StandAlone, or Secondary to
StandAlone.
This cmdlet does not configure a manager as the Secondary role.
To configure an NSX Manager as secondary, you must use
Add-NsxSecondaryManager against the Primary NSX Manager.
PARAMETERS
-Role <String>
New Role for connected NSX Manager
Required? true
Position? 1
Default value
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:\\>Set-NsxManagerRole -Role Primary
Sets the universal sync role to Primary for the connected NSX Manager
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-NsxManagerRole -Role StandAlone
Sets the universal sync role to Standalone for the connected NSX Manager.
Note, if running this against a manager that currently is configured as
secondary, and universal objects exist, then the state will transition to
TRANSIT rather than standalone. The may then be configured as PRIMARY, or
if all universal objects are deleted, as STANDALONE.
RELATED LINKS