Restart-CIVMGuest

This cmdlet restarts the guest operating system of the specified virtual machine.

Syntax

-VM  <CIVM[]>
[-RunAsync]
[-Server  <CIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VM
CIVM[] named
  • pipeline
  • Specifies the virtual machine whose guest operating system you want to restart.
    optional
    RunAsync
    SwitchParameter named 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.
    optional
    Server
    CIServer[] named 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.

    Output

    VMware.VimAutomation.Cloud.Types.V1.CIVM

    Examples


    Example 1

    $myVM = Get-CIVM -Name 'MyVM'
    Restart-CIVMGuest $myVM

    Restarts the guest operating system of the specified virtual machine.

    Example 2

    $myVM = Get-CIVM -Name 'MyVM'
    $task = Restart-CIVMGuest $myVM -RunAsync

    Restarts the guest operating system of the specified virtual machine asynchronously.

    Related Commands

    Feedback

    Was this page helpful?