Set-VDIGuestDefaultSettings

NAME

Set-VDIGuestDefaultSettings

SYNOPSIS

Modifies default settings used to configure a guest VM.

SYNTAX

Set-VDIGuestDefaultSettings [- GroupType < UserGroupTypes > {RDUsers | Administrators}] [- IsUsersGrantedRDPermissions <bool> ] [- PerformAction < PerformAction > {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [- PerformActionAfterSec <uint> ] [- SessionAction < SessionAction > {Disconnect | Logoff}] [- SessionResetTimeoutSec <uint> ] [- SiteId <uint> ] [ < CommonParameters > ]

DESCRIPTION

Modifies default settings used to configure a guest VM.

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

Default settings are defined on a site level and are applied to a guest VM when it is initially added to a site.

PARAMETERS


- SiteId <uint>
Site ID.

        Required?                    false
        Position?                    named
        Default value                0
        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

-none-

OUTPUTS

-none-

EXAMPLES


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

Set-VDIGuestDefaultSettings -ConnectionTimeoutSec 300

Modifies the default connection timeout.

RELATED LINKS