PowerCLI Reference



This cmdlet creates an HCX Appliance.


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

New-HCXAppliance -AdminPassword <SecureString> -Compute <HCXApplianceCompute> -DVS <HCXApplianceDVS> -Datastore <HCXApplianceDatastore> -DestinationSite <HCXSite> -L2Concentrator -NetworkGateway <String> -NetworkIp <String> -RootPassword <SecureString> [-Server <HcxServer[]>] -ApplianceManagementNetwork <HCXApplianceNetwork> [-Name <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

New-HCXAppliance -Appliance <HCXAppliance> -DestinationSite <HCXSite> [-Force] -Redeploy [-Server <HcxServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

New-HCXAppliance -Appliance <HCXAppliance> -DestinationSite <HCXSite> [-Force] [-Server <HcxServer[]>] [-Confirm] [-WhatIf] -Upgrade [<CommonParameters>]

New-HCXAppliance [-Bandwidth <Int32>] -DestinationSite <HCXSite> [-Server <HcxServer[]>] -WANOptimization [-Name <String>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

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.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AdminPasswordSecureStringSpecifies the password by which you can log in to the appliance as an administrator.trueFalse
ApplianceHCXApplianceSpecifies the appliance that you want to redeploy.trueTrue (ByValue)
ApplianceManagementNetworkHCXApplianceNetworkSpecifies the vCenter Server management network that you want to use for the L2Concentrator appliance.trueTrue (ByValue)
BandwidthInt32Specifies the bandwidth that you use in the WANOptimization appliance in MB/s.falseFalse
ComputeHCXApplianceComputeSpecifies the vCenter Server compute for the appliance.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
DatastoreHCXApplianceDatastoreSpecifies the vCenter Server datastore for the appliance.trueTrue (ByValue)
DestinationSiteHCXSiteSpecifies the destination site where you want to deploy or redeploy the appliance.trueTrue (ByValue)
DVSHCXApplianceDVSSpecifies the vCenter Server DVS (Distributed Virtual Switch) for the appliance.trueTrue (ByValue)
ForceSwitchParameterIndicates that you want to force and redeploy the appliance.falseFalse
InterconnectSwitchParameterSpecifies that you want to deploy the Interconnect appliance.trueFalse
L2ConcentratorSwitchParameterSpecifies that you want to deploy the L2Concentrator appliance.trueFalse
ManagementNetworkHCXNetworkSpecifies the management that you use for migration. This is a source site network.trueTrue (ByValue)
NameStringSpecifies the name of the appliance that you want to deploy.falseFalse
NetworkDnsStringSpecifies the DNS IP that you want to assign to the management network.falseFalse
NetworkGatewayStringSpecifies the gateway IP that you want to assign to the management network.trueFalse
NetworkIpStringSpecifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format.trueFalse
RedeploySwitchParameterSpecifies that you want to redeploy an existing appliance.trueFalse
RootPasswordSecureStringSpecifies the password by which you can log in to the appliance as a root user.trueFalse
ServerHcxServer[]Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.falseFalse
StaticRouteHCXStaticRoute[]Specifies the static routes for an Interconnect appliance.falseTrue (ByValue)
UpgradeSwitchParameterSpecifies that you want to upgrade an existing appliance.trueFalse
VMotionNetworkHCXApplianceNetworkSpecifies the vMotion network for the vMotion migration.falseTrue (ByValue)
VMotionNetworkIpStringSpecifies 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.falseFalse
WANOptimizationSwitchParameterSpecifies that you want to deploy the WANOptimization appliance.trueFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type




-------------------------- Example 1 --------------------------

PS C:\> New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -DVS $myDvs -Datastore $myApplianceDatastore -DestinationSite $myDestination -L2Concentrator -NetworkGateway -NetworkIp -RootPassword $myRootPassword -ApplianceManagementNetwork $myApplianceNetwork -Name $myApplianceName

Deploys a new L2Concentrator appliance.

-------------------------- Example 2 --------------------------

PS C:\> New-HCXAppliance -AdminPassword $myAdminPassword -Compute $myApplianceCompute -Datastore $myApplianceDatastore -DestinationSite $myDestination -Interconnect -NetworkGateway -NetworkIp -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.

Copyright © VMware, Inc. All rights reserved.