< Back
Set-NsxManager
Post
NAME Set-NsxManager
SYNOPSIS
Configures appliance settings for an existing NSX Manager appliance.
SYNTAX
Set-NsxManager -SyslogServer <String> [-SyslogPort <Int32>] [-SyslogProtocol <String>] [-Connection <PSObject>]
[<CommonParameters>]
Set-NsxManager -SsoServer <String> [-SsoPort <String>] -SsoUserName <String> -SsoPassword <String> [-SslThumbprint
<String>] [-AcceptAnyThumbprint] [-Connection <PSObject>] [<CommonParameters>]
Set-NsxManager -vCenterServer <String> -vCenterUserName <String> -vCenterPassword <String> [-SslThumbprint
<String>] [-AcceptAnyThumbprint] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
The NSX management plane is provided by NSX Manager, the centralized
network management component of NSX. It provides the single point of
configuration for NSX operations, and provides NSX's REST API.
The Set-NsxManager cmdlet allows configuration of the appliance settings
such as syslog, vCenter registration and SSO configuration.
PARAMETERS
-SyslogServer <String>
Syslog server to which syslogs will be forwarded.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SyslogPort <Int32>
TCP/UDP port on destination syslog server to connect to.
Required? false
Position? named
Default value 514
Accept pipeline input? false
Accept wildcard characters? false
-SyslogProtocol <String>
Syslog Protocol - either TCP or UDP.
Required? false
Position? named
Default value udp
Accept pipeline input? false
Accept wildcard characters? false
-SsoServer <String>
SSO Server to register this NSX Manager with.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoPort <String>
TCP Port on SSO server to connect to when registering.
Required? false
Position? named
Default value 443
Accept pipeline input? false
Accept wildcard characters? false
-SsoUserName <String>
SSO Username used for registration.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoPassword <String>
SSO Password used for registration.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterServer <String>
vCenter server to register this NSX Manager with.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterUserName <String>
UserName used for vCenter connection.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterPassword <String>
Password used for vCenter connection.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SslThumbprint <String>
SSL Thumbprint to validate certificate presented by SSO/vCenter server against.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AcceptAnyThumbprint [<SwitchParameter>]
Accept any SSL certificate presented by SSO/vCenter.
Required? false
Position? named
Default value True
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:\\>Set-NsxManager -NtpServer 0.pool.ntp.org -Timezone UTC
Configures NSX Manager NTP Server.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-NsxManager -SyslogServer syslog.corp.local -SyslogPort 514 -SyslogProtocol tcp
Configures NSX Manager Syslog destination.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-NsxManager -ssoserver sso.corp.local -ssousername administrator@vsphere.local -ssopassword VMware1!
Configures the SSO Server registration of NSX Manager.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Set-NsxManager -vcenterusername administrator@vsphere.local -vcenterpassword VMware1! -vcenterserver
vcenter.corp.local
Configures the vCenter registration of NSX Manager.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Set-NsxManager -vcenterusername administrator@vsphere.local -vcenterpassword VMware1! -vcenterserver
vcenter.corp.local -sslThumbPrint F6:48:11:0E:AC:F7:93:A3:1B:60:8F:A2:53:C4:88:77:3F:CD:B1:81
Configures the vCenter registration of NSX Manager using the specified thumbprint.
RELATED LINKS
SYNOPSIS
Configures appliance settings for an existing NSX Manager appliance.
SYNTAX
Set-NsxManager -SyslogServer <String> [-SyslogPort <Int32>] [-SyslogProtocol <String>] [-Connection <PSObject>]
[<CommonParameters>]
Set-NsxManager -SsoServer <String> [-SsoPort <String>] -SsoUserName <String> -SsoPassword <String> [-SslThumbprint
<String>] [-AcceptAnyThumbprint] [-Connection <PSObject>] [<CommonParameters>]
Set-NsxManager -vCenterServer <String> -vCenterUserName <String> -vCenterPassword <String> [-SslThumbprint
<String>] [-AcceptAnyThumbprint] [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
The NSX management plane is provided by NSX Manager, the centralized
network management component of NSX. It provides the single point of
configuration for NSX operations, and provides NSX's REST API.
The Set-NsxManager cmdlet allows configuration of the appliance settings
such as syslog, vCenter registration and SSO configuration.
PARAMETERS
-SyslogServer <String>
Syslog server to which syslogs will be forwarded.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SyslogPort <Int32>
TCP/UDP port on destination syslog server to connect to.
Required? false
Position? named
Default value 514
Accept pipeline input? false
Accept wildcard characters? false
-SyslogProtocol <String>
Syslog Protocol - either TCP or UDP.
Required? false
Position? named
Default value udp
Accept pipeline input? false
Accept wildcard characters? false
-SsoServer <String>
SSO Server to register this NSX Manager with.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoPort <String>
TCP Port on SSO server to connect to when registering.
Required? false
Position? named
Default value 443
Accept pipeline input? false
Accept wildcard characters? false
-SsoUserName <String>
SSO Username used for registration.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoPassword <String>
SSO Password used for registration.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterServer <String>
vCenter server to register this NSX Manager with.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterUserName <String>
UserName used for vCenter connection.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vCenterPassword <String>
Password used for vCenter connection.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SslThumbprint <String>
SSL Thumbprint to validate certificate presented by SSO/vCenter server against.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AcceptAnyThumbprint [<SwitchParameter>]
Accept any SSL certificate presented by SSO/vCenter.
Required? false
Position? named
Default value True
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:\\>Set-NsxManager -NtpServer 0.pool.ntp.org -Timezone UTC
Configures NSX Manager NTP Server.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-NsxManager -SyslogServer syslog.corp.local -SyslogPort 514 -SyslogProtocol tcp
Configures NSX Manager Syslog destination.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-NsxManager -ssoserver sso.corp.local -ssousername administrator@vsphere.local -ssopassword VMware1!
Configures the SSO Server registration of NSX Manager.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Set-NsxManager -vcenterusername administrator@vsphere.local -vcenterpassword VMware1! -vcenterserver
vcenter.corp.local
Configures the vCenter registration of NSX Manager.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Set-NsxManager -vcenterusername administrator@vsphere.local -vcenterpassword VMware1! -vcenterserver
vcenter.corp.local -sslThumbPrint F6:48:11:0E:AC:F7:93:A3:1B:60:8F:A2:53:C4:88:77:3F:CD:B1:81
Configures the vCenter registration of NSX Manager using the specified thumbprint.
RELATED LINKS