Set-VDIGuest

NAME

Set-VDIGuest

SYNOPSIS

Modifies guest VM settings.

SYNTAX

Set-VDIGuest [-VDIHostId] <uint> [-Id] <string> [-ComputerName <string>] [-GroupType <UserGroupTypes> {RDUsers | Administrators}] [-IgnoreGuest <bool>] [-InheritDefVDIActionSettings <bool>] [-InheritDefVDISecuritySettings <bool>] [-IsUsersGrantedRDPermissions <bool>] [-PerformAction <PerformAction> {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-Port <uint>] [-SessionAction <SessionAction> {Disconnect | Logoff}] [-SessionResetTimeoutSec <uint>] [<CommonParameters>]

Set-VDIGuest [-InputObject] <VDIGuest> [-ComputerName <string>] [-GroupType <UserGroupTypes> {RDUsers | Administrators}] [-IgnoreGuest <bool>] [-InheritDefVDIActionSettings <bool>] [-InheritDefVDISecuritySettings <bool>] [-IsUsersGrantedRDPermissions <bool>] [-PerformAction <PerformAction> {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-Port <uint>] [-SessionAction <SessionAction> {Disconnect | Logoff}] [-SessionResetTimeoutSec <uint>] [<CommonParameters>]

DESCRIPTION

Modifies 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

-InheritDefVDIActionSettings <bool>
Inherit Default VDI Action Settings for the specified guest VM. 

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

-InheritDefVDISecuritySettings <bool>
Inherit Default VDI Security Settings for the specified guest VM. 

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

-SessionResetTimeoutSec <uint>
Reset session after (in seconds). 

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

-SessionResetTimeout <uint>
Reset session after (in seconds).

This is an alias of the SessionResetTimeoutSec parameter. 

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

-SessionAction <SessionAction>
Session change state.

Possible values: Disconnect, Logoff 

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

-PerformAction <PerformAction>
Perform action on session change.

Possible values: DoNothing, Shutdown, Restart, Suspend, Delete, Unassign, Recreate 

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

-PerformActionAfterSec <uint>
Perform action after (in seconds). 

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

-PerformActionAfter <uint>
Perform action after (in seconds).

This is an alias of the PerformActionAfterSec parameter. 

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

-IsUsersGrantedRDPermissions <bool>
Grant users RDP permission 

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

-GroupType <UserGroupTypes>
Group type that will get RDP premission

Possible values: RDUsers, Administrators 

        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

VDIGuest

OUTPUTS

-none-

EXAMPLES


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

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

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

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

Set-VDIGuest $VDIGuest -InheritDefVDIActionSettings $True

Inherits the default action 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 -InheritDefVDISecuritySettings $True

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

RELATED LINKS