Restart-vRAMachineGuestOS
SYNOPSIS
Request a guest os restart
SYNTAX
RebootByName (Default)
Restart-vRAMachineGuestOS -Name <String[]> [-WaitForCompletion] [-CompletionTimeout <Int32>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
RebootById
Restart-vRAMachineGuestOS -Id <String[]> [-WaitForCompletion] [-CompletionTimeout <Int32>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Request the guest OS to restart
EXAMPLES
EXAMPLE 1
Restart-vRAMachineGuestOS -Id 'b1dd48e71d74267559bb930934470'
EXAMPLE 2
Restart-vRAMachineGuestOS -Name 'iaas01'
EXAMPLE 3
Restart-vRAMachineGuestOS -Name 'iaas01' -WaitForCompletion
EXAMPLE 4
Restart-vRAMachineGuestOS -Name 'iaas01' -WaitForCompletion -CompletionTimeout 300
PARAMETERS
-Id
The ID of the vRA Machine
Type: String[]
Parameter Sets: RebootById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name
The Name of the vRA Machine
Type: String[]
Parameter Sets: RebootByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WaitForCompletion
If this flag is added, this function will wait for the power state of the machine to = ON. (note: machine may still be completing OS boot procedure when this function is complete)
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-CompletionTimeout
The default of this paramter is 2 minutes (120 seconds), but this parameter can be overriden here
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 120
Accept pipeline input: False
Accept wildcard characters: False
-Force
Force this change
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.