Syntax
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>]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.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| AdminPassword | SecureString | Specifies the password by which you can log in to the appliance as an administrator. | true | False | |
| Appliance | HCXAppliance | Specifies the appliance that you want to redeploy. | true | True (ByValue) | |
| ApplianceManagementNetwork | HCXApplianceNetwork | Specifies the vCenter Server management network that you want to use for the L2Concentrator appliance. | true | True (ByValue) | |
| Bandwidth | Int32 | Specifies the bandwidth that you use in the WANOptimization appliance in MB/s. | false | False | |
| Compute | HCXApplianceCompute | Specifies the vCenter Server compute for the appliance. | true | True (ByValue) | |
| Confirm | SwitchParameter | If 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. | false | False | |
| Datastore | HCXApplianceDatastore | Specifies the vCenter Server datastore for the appliance. | true | True (ByValue) | |
| DestinationSite | HCXSite | Specifies the destination site where you want to deploy or redeploy the appliance. | true | True (ByValue) | |
| DVS | HCXApplianceDVS | Specifies the vCenter Server DVS (Distributed Virtual Switch) for the appliance. | true | True (ByValue) | |
| Force | SwitchParameter | Indicates that you want to force and redeploy the appliance. | false | False | |
| Interconnect | SwitchParameter | Specifies that you want to deploy the Interconnect appliance. | true | False | |
| L2Concentrator | SwitchParameter | Specifies that you want to deploy the L2Concentrator appliance. | true | False | |
| ManagementNetwork | HCXNetwork | Specifies the management that you use for migration. This is a source site network. | true | True (ByValue) | |
| Name | String | Specifies the name of the appliance that you want to deploy. | false | False | |
| NetworkDns | String | Specifies the DNS IP that you want to assign to the management network. | false | False | |
| NetworkGateway | String | Specifies the gateway IP that you want to assign to the management network. | true | False | |
| NetworkIp | String | Specifies the network IP and prefix length of the management network provided in the <network-ip>/<prefix-length> format. | true | False | |
| Redeploy | SwitchParameter | Specifies that you want to redeploy an existing appliance. | true | False | |
| RootPassword | SecureString | Specifies the password by which you can log in to the appliance as a root user. | true | False | |
| Server | HcxServer[] | 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. | false | False | |
| StaticRoute | HCXStaticRoute[] | Specifies the static routes for an Interconnect appliance. | false | True (ByValue) | |
| Upgrade | SwitchParameter | Specifies that you want to upgrade an existing appliance. | true | False | |
| VMotionNetwork | HCXApplianceNetwork | Specifies the vMotion network for the vMotion migration. | false | True (ByValue) | |
| VMotionNetworkIp | String | 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. | false | False | |
| WANOptimization | SwitchParameter | Specifies that you want to deploy the WANOptimization appliance. | true | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXJobNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> 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 --------------------------
PS C:\> 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.