< Back
Start-VsphereVm
Post
NAME Start-VsphereVm
SYNOPSIS
Starts a VM.
SYNTAX
Start-VsphereVm -InputObject <PSObject[]> -DatacenterId <String> [-WaitForVmState {VM Powered On | VM Guest OS
Running | VM Tools Running | Do Not Wait}] [-OverrideAutomationLevel {fullyAutomated | manual |
partiallyAutomated}] [-ReserveResources <Boolean>] [-TimeoutSeconds <UInt32>] -Connection <Hashtable>
[<CommonParameters>]
Start-VsphereVm -VmId <String[]> -DatacenterId <String> [-WaitForVmState {VM Powered On | VM Guest OS Running | VM
Tools Running | Do Not Wait}] [-OverrideAutomationLevel {fullyAutomated | manual | partiallyAutomated}]
[-ReserveResources <Boolean>] [-TimeoutSeconds <UInt32>] -Connection <Hashtable> [<CommonParameters>]
DESCRIPTION
Starts a VM.
PARAMETERS
-InputObject <PSObject[]>
Object representing the VM that is to be started. Use Get-VsphereObject to retrieve input object.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DatacenterId <String>
ID (managed object reference) of the datacenter on which the VM should be started.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-WaitForVmState [<String>]
Specifies a VM state that the command will be waiting for before completing. Accepted values are:
VM Powered On ???????? activity waits until the VM is in poweredOn state.
VM Guest OS Running ???????? activity waits until VM Guest operating system is in running state.
VM Tools Running ???????? activity waits until VMware Tools are in guestToolsRunning running state.
Do Not Wait ???????? activity does not wait.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OverrideAutomationLevel [<String>]
Override the DRS automation level. Accepted values are:
fullyAutomated - Specifies that VirtualCenter should automate both the migration of virtual machines and their
placement with a host at power on.
manual - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for
placement with a host, but should not implement the recommendations automatically.
partiallyAutomated - Specifies that VirtualCenter should generate recommendations for virtual machine
migration and for placement with a host, but should automatically implement only the placement at power on.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ReserveResources [<Boolean>]
Reserve resources for the powering-on VMs throughout the power-on session. When this option is set to true,
the server will return at most one recommended host per manual VM, and the VM's reservations are held on the
recommended host until the VM is actually powered on (either by applying the recommendation or by a power-on
request on the VM), or until the recommendation is canceled, or until the recommendation expires. The
expiration time is currently set to 10 minutes. This option does not have an effect on automatic VMs since
their recommendations are executed immediately. This option is effective on DRS clusters only.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-TimeoutSeconds [<UInt32>]
Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for
a VM state. If this parameter is not specified and Wait For VM State is configured so that the activity waits,
the activity will not time out, it will wait indefinitely until the specified state is reached.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Connection <Hashtable>
Specifies connection information to the vCenter server. For example:
@{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license
key>;SkipCertificateValidation=$false}
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-VmId <String[]>
ID (managed object reference) of the VM that is to be started.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject[]
OUTPUTS
System.String
ID (managed object reference) of the VM that was started.
RELATED LINKS
SYNOPSIS
Starts a VM.
SYNTAX
Start-VsphereVm -InputObject <PSObject[]> -DatacenterId <String> [-WaitForVmState {VM Powered On | VM Guest OS
Running | VM Tools Running | Do Not Wait}] [-OverrideAutomationLevel {fullyAutomated | manual |
partiallyAutomated}] [-ReserveResources <Boolean>] [-TimeoutSeconds <UInt32>] -Connection <Hashtable>
[<CommonParameters>]
Start-VsphereVm -VmId <String[]> -DatacenterId <String> [-WaitForVmState {VM Powered On | VM Guest OS Running | VM
Tools Running | Do Not Wait}] [-OverrideAutomationLevel {fullyAutomated | manual | partiallyAutomated}]
[-ReserveResources <Boolean>] [-TimeoutSeconds <UInt32>] -Connection <Hashtable> [<CommonParameters>]
DESCRIPTION
Starts a VM.
PARAMETERS
-InputObject <PSObject[]>
Object representing the VM that is to be started. Use Get-VsphereObject to retrieve input object.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DatacenterId <String>
ID (managed object reference) of the datacenter on which the VM should be started.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-WaitForVmState [<String>]
Specifies a VM state that the command will be waiting for before completing. Accepted values are:
VM Powered On ???????? activity waits until the VM is in poweredOn state.
VM Guest OS Running ???????? activity waits until VM Guest operating system is in running state.
VM Tools Running ???????? activity waits until VMware Tools are in guestToolsRunning running state.
Do Not Wait ???????? activity does not wait.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-OverrideAutomationLevel [<String>]
Override the DRS automation level. Accepted values are:
fullyAutomated - Specifies that VirtualCenter should automate both the migration of virtual machines and their
placement with a host at power on.
manual - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for
placement with a host, but should not implement the recommendations automatically.
partiallyAutomated - Specifies that VirtualCenter should generate recommendations for virtual machine
migration and for placement with a host, but should automatically implement only the placement at power on.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ReserveResources [<Boolean>]
Reserve resources for the powering-on VMs throughout the power-on session. When this option is set to true,
the server will return at most one recommended host per manual VM, and the VM's reservations are held on the
recommended host until the VM is actually powered on (either by applying the recommendation or by a power-on
request on the VM), or until the recommendation is canceled, or until the recommendation expires. The
expiration time is currently set to 10 minutes. This option does not have an effect on automatic VMs since
their recommendations are executed immediately. This option is effective on DRS clusters only.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-TimeoutSeconds [<UInt32>]
Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for
a VM state. If this parameter is not specified and Wait For VM State is configured so that the activity waits,
the activity will not time out, it will wait indefinitely until the specified state is reached.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Connection <Hashtable>
Specifies connection information to the vCenter server. For example:
@{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license
key>;SkipCertificateValidation=$false}
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-VmId <String[]>
ID (managed object reference) of the VM that is to be started.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject[]
OUTPUTS
System.String
ID (managed object reference) of the VM that was started.
RELATED LINKS