Restart-VM

NAME

Restart-VM

SYNOPSIS

Restarts a virtual machine.

SYNTAX

Restart-VM [-VDIHostId] <uint> -Id <string> [-SiteId <uint>] [<CommonParameters>]

Restart-VM [-InputObject] <VM> [<CommonParameters>]

DESCRIPTION

Restarts a virtual machine.

PARAMETERS


-VDIHostId <uint>
The name of the target VDI Host server. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <string>
Target virtual machine UUID. 

        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID.

If the parameter is omitted, the site ID of the Licensing Server is used. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <VM>
The VM on which to perform the power operation.

To obtain an object of type VM, use the Get-VM cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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 documentation.

INPUTS

VM

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Restart-VM -VDIHostId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0

Restarts the specified virtual machine on the specified VDI Host ID in the Licensing Server site.

To specify a different site, use the -SiteId parameter.

---------- EXAMPLE 2 ----------

Get-VM -VDIHostId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0 | Restart-VM

Restarts the virtual machine which is identified by an object obtained from the pipeline output.

RELATED LINKS