vSphere PowerCLI Reference

New-CIVM

Synopsis

This cmdlet creates a new cloud virtual machine.

Syntax

New-CIVM -VApp <CIVApp> -VMTemplate <CIVMTemplate> [[-Name] <String>] [-ComputerName <String>] [-RunAsync] [-Server <CIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-CIVM
Restart-CIVM
Start-CIVM
Suspend-CIVM

Detailed Description

This cmdlet creates a new cloud virtual machine into an existing vApp by using a specified virtual machine template.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies the name of the newly created cloud virtual machine. If not specified, the name of the virtual machine template is used.falsefalse
ComputerNameStringSpecifies the computer name to be applied to the cloud virtual machine with guest customization.falsefalse
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
RunAsyncSwitchParameterIndicates 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 vSphere PowerCLI console.falsefalse
ServerCIServer[]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.falsefalse
VAppCIVAppSpecifies the vApp to which you want to add the cloud virtual machine.truetrue (ByValue)
VMTemplateCIVMTemplateSpecifies the virtual machine template from which the new cloud virtual machine is created.truetrue (ByValue)
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The newly created CIVM object

Notes

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".


Copyright © 1998 - 2014 VMware, Inc. All rights reserved.