Syntax
New-CIVM [[-Name] <String>] [-ComputerName <String>] [-RunAsync] [-Server <CIServer[]>] -VApp <CIVApp> -VMTemplate <CIVMTemplate> [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet creates a new cloud virtual machine into an existing vApp by using a specified virtual machine template.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String | Specifies the name of the newly created cloud virtual machine. If not specified, the name of the virtual machine template is used. | false | False | |
| ComputerName | String | Specifies the computer name to be applied to the cloud virtual machine with guest customization. | false | False | |
| 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 | |
| RunAsync | SwitchParameter | Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console. | false | False | |
| Server | CIServer[] | Specifies the cloud servers 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 Connect-CIServer. | false | False | |
| VApp | CIVApp | Specifies the vApp to which you want to add the cloud virtual machine. | true | True (ByValue) | |
| VMTemplate | CIVMTemplate | Specifies the virtual machine template from which the new cloud virtual machine is created. | true | True (ByValue) | |
| 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
The newly created CIVM objectNotes
Examples
-------------------------- Example 1 --------------------------
$templateVM = Get-CIVMTemplate -Name "myTemplateVM" Get-CIVApp "myCIVApp" | New-CIVM -Name "myVM" -VMTemplate $templateVM
Retrieves a virtual machine template named "myTemplateVM", creates a cloud virtual machine named "myVM" from the template, and adds it to a cloud vApp named "myCIVApp".