< Back
New-NsxManager
Post
NAME New-NsxManager
SYNOPSIS
Uses an existing PowerCLI connection to deploy and configure the NSX
Manager VM from OVA.
SYNTAX
New-NsxManager -NsxManagerOVF <String> -Name <String> -ClusterName <String> -ManagementPortGroupName <String>
-DatastoreName <String> -FolderName <String> -CliPassword <String> -CliEnablePassword <String> -Hostname <String>
-IpAddress <IPAddress> -Netmask <IPAddress> -Gateway <IPAddress> -DnsServer <IPAddress[]> -DnsDomain <String>
-NtpServer <IPAddress> [-ManagerMemoryGB <Int32>] [-EnableSsh] [-DiskStorageFormat <String>] [<CommonParameters>]
New-NsxManager -NsxManagerOVF <String> -Name <String> -ClusterName <String> -ManagementPortGroupName <String>
-DatastoreName <String> -FolderName <String> -CliPassword <String> -CliEnablePassword <String> -Hostname <String>
-IpAddress <IPAddress> -Netmask <IPAddress> -Gateway <IPAddress> -DnsServer <IPAddress[]> -DnsDomain <String>
-NtpServer <IPAddress> [-ManagerMemoryGB <Int32>] -StartVM [-Wait] [-WaitTimeout <Int32>] [-EnableSsh]
[-DiskStorageFormat <String>] [<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 New-NsxManager cmdlet deploys and configures a new NSX Manager appliance
using PowerCLI
PARAMETERS
-NsxManagerOVF <String>
Local Path to NSX MAnager OVA
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the deployed VM.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClusterName <String>
Name of the vSphere Cluster to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ManagementPortGroupName <String>
Name of the portgroup to which the management interface of the VM will be connected.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DatastoreName <String>
Name of the Datastore to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FolderName <String>
Name of the vSphere VM Inventory folder to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CliPassword <String>
CLI Password for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CliEnablePassword <String>
Enable password for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Hostname <String>
Guest Hostname for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IpAddress <IPAddress>
IP Address assigned to the management interface.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Netmask <IPAddress>
Netmask for the management interface.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Gateway <IPAddress>
Gateway Address for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DnsServer <IPAddress[]>
DNS Server for the deployed NSX Manager
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DnsDomain <String>
DNS Domain Name for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NtpServer <IPAddress>
NTP Server for the deployed NSX Manager (One only.)
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ManagerMemoryGB <Int32>
Configured Memory for the deployed VM. Overrides default in OVA. Non-Production use only!
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StartVM [<SwitchParameter>]
Start the VM once deployment is completed.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the NSX Manager API to become available once deployment is complete and the appliance is started.
Requires -StartVM, and network reachability between this machine and the management interface of the NSX
Manager.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WaitTimeout <Int32>
How long to wait before timeout for NSX MAnager API to become available once the VM has been started.
Required? false
Position? named
Default value 600
Accept pipeline input? false
Accept wildcard characters? false
-EnableSsh [<SwitchParameter>]
Enable SSH on the deployed NSX Manager.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DiskStorageFormat <String>
Disk format on the deployed NSX Manager
Required? false
Position? named
Default value Thick
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
System.String
System.Int32
System.RuntimeType
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-NSXManager -NsxManagerOVF ".\\VMware-NSX-Manager-6.2.0-2986609.ova"
-Name TestingNSXM -ClusterName Cluster1 -ManagementPortGroupName Net1
-DatastoreName DS1 -FolderName Folder1 -CliPassword VMware1!VMware1!
-CliEnablePassword VMware1!VMware1! -Hostname NSXManagerHostName
-IpAddress 1.2.3.4 -Netmask 255.255.255.0 -Gateway 1.2.3.1
-DnsServer 1.2.3.5 -DnsDomain corp.local -NtpServer 1.2.3.5 -EnableSsh
-StartVm -wait
Deploys a new NSX Manager, starts the VM, and blocks until the API becomes
available.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$nsxManagerBuildParams = @{
NsxManagerOVF = ".\\VMware-NSX-Manager-6.2.0-2986609.ova"
Name = TestingNSXM
ClusterName = Cluster1
ManagementPortGroupName = Net1
DatastoreName = DS1
FolderName = Folder1
CliPassword = VMware1!VMware1!
CliEnablePassword = VMware1!VMware1!
Hostname = NSXManagerHostName
IpAddress = 1.2.3.4
Netmask = 255.255.255.0
Gateway = 1.2.3.1
DnsServer = 1.2.3.5
DnsDomain = corp.local
NtpServer = 1.2.3.5
EnableSsh = $true
StartVm = $true
Wait = $true
} # end $nsxManagerBuildParams
New-NSXManager @nsxManagerBuildParams
Uses 'splatting' technique to specify build configuration and then deploys a new NSX Manager, starts the VM, and
blocks until the API becomes
available.
RELATED LINKS
SYNOPSIS
Uses an existing PowerCLI connection to deploy and configure the NSX
Manager VM from OVA.
SYNTAX
New-NsxManager -NsxManagerOVF <String> -Name <String> -ClusterName <String> -ManagementPortGroupName <String>
-DatastoreName <String> -FolderName <String> -CliPassword <String> -CliEnablePassword <String> -Hostname <String>
-IpAddress <IPAddress> -Netmask <IPAddress> -Gateway <IPAddress> -DnsServer <IPAddress[]> -DnsDomain <String>
-NtpServer <IPAddress> [-ManagerMemoryGB <Int32>] [-EnableSsh] [-DiskStorageFormat <String>] [<CommonParameters>]
New-NsxManager -NsxManagerOVF <String> -Name <String> -ClusterName <String> -ManagementPortGroupName <String>
-DatastoreName <String> -FolderName <String> -CliPassword <String> -CliEnablePassword <String> -Hostname <String>
-IpAddress <IPAddress> -Netmask <IPAddress> -Gateway <IPAddress> -DnsServer <IPAddress[]> -DnsDomain <String>
-NtpServer <IPAddress> [-ManagerMemoryGB <Int32>] -StartVM [-Wait] [-WaitTimeout <Int32>] [-EnableSsh]
[-DiskStorageFormat <String>] [<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 New-NsxManager cmdlet deploys and configures a new NSX Manager appliance
using PowerCLI
PARAMETERS
-NsxManagerOVF <String>
Local Path to NSX MAnager OVA
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the deployed VM.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClusterName <String>
Name of the vSphere Cluster to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ManagementPortGroupName <String>
Name of the portgroup to which the management interface of the VM will be connected.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DatastoreName <String>
Name of the Datastore to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FolderName <String>
Name of the vSphere VM Inventory folder to which the VM will be deployed.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CliPassword <String>
CLI Password for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CliEnablePassword <String>
Enable password for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Hostname <String>
Guest Hostname for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IpAddress <IPAddress>
IP Address assigned to the management interface.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Netmask <IPAddress>
Netmask for the management interface.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Gateway <IPAddress>
Gateway Address for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DnsServer <IPAddress[]>
DNS Server for the deployed NSX Manager
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DnsDomain <String>
DNS Domain Name for the deployed NSX Manager.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NtpServer <IPAddress>
NTP Server for the deployed NSX Manager (One only.)
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ManagerMemoryGB <Int32>
Configured Memory for the deployed VM. Overrides default in OVA. Non-Production use only!
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StartVM [<SwitchParameter>]
Start the VM once deployment is completed.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the NSX Manager API to become available once deployment is complete and the appliance is started.
Requires -StartVM, and network reachability between this machine and the management interface of the NSX
Manager.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WaitTimeout <Int32>
How long to wait before timeout for NSX MAnager API to become available once the VM has been started.
Required? false
Position? named
Default value 600
Accept pipeline input? false
Accept wildcard characters? false
-EnableSsh [<SwitchParameter>]
Enable SSH on the deployed NSX Manager.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DiskStorageFormat <String>
Disk format on the deployed NSX Manager
Required? false
Position? named
Default value Thick
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
System.String
System.Int32
System.RuntimeType
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-NSXManager -NsxManagerOVF ".\\VMware-NSX-Manager-6.2.0-2986609.ova"
-Name TestingNSXM -ClusterName Cluster1 -ManagementPortGroupName Net1
-DatastoreName DS1 -FolderName Folder1 -CliPassword VMware1!VMware1!
-CliEnablePassword VMware1!VMware1! -Hostname NSXManagerHostName
-IpAddress 1.2.3.4 -Netmask 255.255.255.0 -Gateway 1.2.3.1
-DnsServer 1.2.3.5 -DnsDomain corp.local -NtpServer 1.2.3.5 -EnableSsh
-StartVm -wait
Deploys a new NSX Manager, starts the VM, and blocks until the API becomes
available.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$nsxManagerBuildParams = @{
NsxManagerOVF = ".\\VMware-NSX-Manager-6.2.0-2986609.ova"
Name = TestingNSXM
ClusterName = Cluster1
ManagementPortGroupName = Net1
DatastoreName = DS1
FolderName = Folder1
CliPassword = VMware1!VMware1!
CliEnablePassword = VMware1!VMware1!
Hostname = NSXManagerHostName
IpAddress = 1.2.3.4
Netmask = 255.255.255.0
Gateway = 1.2.3.1
DnsServer = 1.2.3.5
DnsDomain = corp.local
NtpServer = 1.2.3.5
EnableSsh = $true
StartVm = $true
Wait = $true
} # end $nsxManagerBuildParams
New-NSXManager @nsxManagerBuildParams
Uses 'splatting' technique to specify build configuration and then deploys a new NSX Manager, starts the VM, and
blocks until the API becomes
available.
RELATED LINKS