Set-VDIGuest

NAME

Set-VDIGuest

SYNOPSIS

Modifies guest VM settings.

SYNTAX

Set-VDIGuest [-VDIHostId] <uint> [-Id] <string> [-ComputerName <string>] [-ConnectionTimeout <uint>] [-DisconnectMode <VDIDisconnectMode> {KeepCurrentState | Stop | Reset | Suspend}] [-EndSessionTimeout <uint>] [-IgnoreGuest <bool>] [-OnDisconnectTimeout <uint>] [-OverrideDefaultSettings <bool>] [-Port <uint>] [<CommonParameters>]

Set-VDIGuest [-InputObject] <VDIGuest> [-ComputerName <string>] [-ConnectionTimeout <uint>] [-DisconnectMode <VDIDisconnectMode> {KeepCurrentState | Stop | Reset | Suspend}] [-EndSessionTimeout <uint>] [-IgnoreGuest <bool>] [-OnDisconnectTimeout <uint>] [-OverrideDefaultSettings <bool>] [-Port <uint>] [<CommonParameters>]

DESCRIPTION

The Set-VDIGuest cmdlet is used to modify settings of a guest VM.

For each setting, the cmdlet includes a corresponding input parameter. To modify a setting, specify a parameter and its value.

PARAMETERS


-VDIHostId <uint>
The ID of a VDI Host server on which the target VM resides.

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

-Id <string>
The ID of the target guest VM.

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

-InputObject <VDIGuest>
An object of the VDIGuest representing the target VM.

To obtain the object, use the Get-VDIGuest cmdlet.

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

-IgnoreGuest <bool>
Ignore the specified guest VM in a site.

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

-ComputerName <string>
A computer name.

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

-Port <uint>
Specifies the port number for the RAS Guest Agent.

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

-OverrideDefaultSettings <bool>
Override the default settings for the specified guest VM.

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

-DisconnectMode <VDIDisconnectMode>
Sets the disconnection mode after the timeout is reached.

Possible values: KeepCurrentState, Stop, Reset, Suspend

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

-ConnectionTimeout <uint>
Specifies the 'Connection Timeout' property (in seconds).

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

-OnDisconnectTimeout <uint>
Specifies the 'On Disconnect Timeout' property (in seconds).

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

-EndSessionTimeout <uint>
Specifies the 'End Session Timeout' property (in seconds).

        Required?                    false
        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 documentation. 

INPUTS

PSAdmin.VDIGuest

OUTPUTS

-none-

EXAMPLES


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

Set-VDIGuest -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0 -OverrideDefaultSettings $True

Overrides the default settings for the guest VM specified by the VDI Host ID and the VM ID.

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

Set-VDIGuest $VDIGuest -OverrideDefaultSettings $True

Overrides the default settings for the guest VM specified by the $VDIGuest variable, which is an object of type VDIGuest.

The object is obtained using the Get-VDIGuest cmdlet.

---------- EXAMPLE 3 ----------

Get-VDIGuest -VDIHostId 3 -Id 42311235-09c5-ca15-337d-b9723015edf0 | Set-VDIGuest -OverrideDefaultSettings $True

Overrides the default settings for the guest VM represented by a VDIGuest object obtained from the pipeline output.

RELATED LINKS