New-HCXAppliance Command | Vmware PowerCLI Reference

New-HCXAppliance

This cmdlet creates an HCX Appliance which can be of type Interconnect, L2Concentrator, WANOptimization, and Redeploy. You can use the HCXJob output to retrieve job details by running the Get-HCXJob cmdlet.

Syntax

New-HCXAppliance
-AdminPassword < SecureString >
-Compute < HCXApplianceCompute >
-Datastore < HCXApplianceDatastore >
-DestinationSite < HCXSite >
-Interconnect
-ManagementNetwork < HCXNetwork >
-NetworkGateway < String >
-NetworkIp < String >
-RootPassword < SecureString >
[-Name < String > ]
[-NetworkDns < String > ]
[-Server < HcxServer[] > ]
[-StaticRoute < HCXStaticRoute[] > ]
[-VMotionNetwork < HCXApplianceNetwork > ]
[-VMotionNetworkIp < String > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
AdminPassword SecureString named
Specifies the password by which you can log in to the appliance as an administrator.
required
Compute HCXApplianceCompute named
  • pipeline
Specifies the vCenter Server compute for the appliance.
required
Datastore HCXApplianceDatastore named
  • pipeline
Specifies the vCenter Server datastore for the appliance.
required
DestinationSite HCXSite named
  • pipeline
Specifies the destination site where you want to deploy or redeploy the appliance.
required
Interconnect SwitchParameter named
Specifies that you want to deploy the Interconnect appliance.
required
ManagementNetwork HCXNetwork named
  • pipeline
Specifies the management that you use for migration. This is a source site network.
required
NetworkGateway String named
Specifies the gateway IP that you want to assign to the management network.
required
NetworkIp String named
Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.
required
RootPassword SecureString named
Specifies the password by which you can log in to the appliance as a root user.
optional Name String named
Specifies the name of the appliance that you want to deploy.
optional NetworkDns String named
Specifies the DNS IP that you want to assign to the management network.
optional Server HcxServer[] named
  • wildcards
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.
optional StaticRoute HCXStaticRoute[] named
  • pipeline
Specifies the static routes for an Interconnect appliance.
optional VMotionNetwork HCXApplianceNetwork named
  • pipeline
Specifies the vMotion network for the vMotion migration.
optional VMotionNetworkIp String named
Specifies the vMotion network IP that you want to assign. This field is necessary when vMotion network is provided in the <network-ip>/<prefix-length> format.
New-HCXAppliance
-AdminPassword < SecureString >
-ApplianceManagementNetwork < HCXApplianceNetwork >
-Compute < HCXApplianceCompute >
-DVS < HCXApplianceDVS >
-Datastore < HCXApplianceDatastore >
-DestinationSite < HCXSite >
-L2Concentrator
-NetworkGateway < String >
-NetworkIp < String >
-RootPassword < SecureString >
[-Name < String > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
AdminPassword SecureString named
Specifies the password by which you can log in to the appliance as an administrator.
required
ApplianceManagementNetwork HCXApplianceNetwork named
  • pipeline
Specifies the vCenter Server management network that you want to use for the L2Concentrator appliance.
required
Compute HCXApplianceCompute named
  • pipeline
Specifies the vCenter Server compute for the appliance.
required
DVS HCXApplianceDVS named
  • pipeline
Specifies the vCenter Server DVS (Distributed Virtual Switch) for the appliance.
required
Datastore HCXApplianceDatastore named
  • pipeline
Specifies the vCenter Server datastore for the appliance.
required
DestinationSite HCXSite named
  • pipeline
Specifies the destination site where you want to deploy or redeploy the appliance.
required
L2Concentrator SwitchParameter named
Specifies that you want to deploy the L2Concentrator appliance.
required
NetworkGateway String named
Specifies the gateway IP that you want to assign to the management network.
required
NetworkIp String named
Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.
required
RootPassword SecureString named
Specifies the password by which you can log in to the appliance as a root user.
optional Name String named
Specifies the name of the appliance that you want to deploy.
optional Server HcxServer[] named
  • wildcards
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.
New-HCXAppliance
-Appliance < HCXAppliance >
-DestinationSite < HCXSite >
-Redeploy
[-Force ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Appliance HCXAppliance named
  • pipeline
Specifies the appliance that you want to redeploy.
required
DestinationSite HCXSite named
  • pipeline
Specifies the destination site where you want to deploy or redeploy the appliance.
required
Redeploy SwitchParameter named
Specifies that you want to redeploy an existing appliance.
optional Force SwitchParameter named
Indicates that you want to force and redeploy the appliance.
optional Server HcxServer[] named
  • wildcards
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.
New-HCXAppliance
-Appliance < HCXAppliance >
-DestinationSite < HCXSite >
-Upgrade
[-Force ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Appliance HCXAppliance named
  • pipeline
Specifies the appliance that you want to redeploy.
required
DestinationSite HCXSite named
  • pipeline
Specifies the destination site where you want to deploy or redeploy the appliance.
required
Upgrade SwitchParameter named
Specifies that you want to upgrade an existing appliance.
optional Force SwitchParameter named
Indicates that you want to force and redeploy the appliance.
optional Server HcxServer[] named
  • wildcards
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.
New-HCXAppliance
-DestinationSite < HCXSite >
-WANOptimization
[-Bandwidth < Int32 > ]
[-Name < String > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DestinationSite HCXSite named
  • pipeline
Specifies the destination site where you want to deploy or redeploy the appliance.
required
WANOptimization SwitchParameter named
Specifies that you want to deploy the WANOptimization appliance.
optional Bandwidth Int32 named
Specifies the bandwidth that you use in the WANOptimization appliance in MB/s.
optional Name String named
Specifies the name of the appliance that you want to deploy.
optional Server HcxServer[] named
  • wildcards
Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.

Output

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Examples

Example 1

New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -DVS $myDvs -Datastore $myApplianceDatastore -DestinationSite $myDestination -L2Concentrator -NetworkGateway 192.168.4.253 -NetworkIp 192.168.4.220/24 -RootPassword $myRootPassword -ApplianceManagementNetwork $myApplianceNetwork -Name $myApplianceName

Deploys a new L2Concentrator appliance.

Example 2

New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -Datastore $myApplianceDatastore -DestinationSite $myDestination -Interconnect -NetworkGateway 192.168.4.253 -NetworkIp 192.168.4.201/24 -RootPassword $myRootPassword -ManagementNetwork $myNetwork -Name $myApplianceName

Deploys a new Interconnect appliance.

Example 3

$destination = Get-HCXSite -Destination
New-HCXAppliance -DestinationSite $destination -WANOptimization -Name "myApplianceName"

Deploys a new WANOptimization appliance.

Example 4

$appliance = Get-HCXAppliance -Name "myAppliance"
$destination = Get-HCXSite -Destination
New-HCXAppliance -Appliance $appliance -DestinationSite $destination -Redeploy

Redeploys an existing appliance.

Example 5

$appliance = Get-HCXAppliance -Name "myAppliance"
$destination = Get-HCXSite -Destination
New-HCXAppliance -Upgrade -Appliance $appliance -DestinationSite $destination

Upgrades an existing appliance.

Related Commands

HCXAppliance

This cmdlet retrieves the appliances of type Interconnect, WAN Optimization, and Network Extension that are available on the HCX Server system.

This cmdlet creates an HCX Appliance.

This cmdlet removes an HCX Appliance.

This cmdlet modifies the HCX appliances of type Interconnect and Network Extension that are available on the HCX Server system.