New-RDSScheduleDisable

NAME

New-RDSScheduleDisable

SYNOPSIS

Creates an RD Session Host scheduler job of type "Disable (server or group)".

SYNTAX

New-RDSScheduleDisable - End <DateTime> - Name <string> - Start <DateTime> - TargetType < SchedTargetType > {Server | ServerGroup} [- Description <string> ] [- DisableAction < DisableAction > {KeepSessionState | DisconnectActiveSessions | ResetAllSessions}] [- Message <string> ] [- Repeat < RepeatType > {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [- SendMsgBeforeMins <uint> ] [- SiteId <uint> ] [- TargetGroup < RDSGroup > ] [- TargetServer < RDS > ] [ < CommonParameters > ]

DESCRIPTION

Creates an RD Session Host scheduler job of type "Disable (server or group)".

PARAMETERS


- DisableAction < DisableAction >
The action that should be performed when the server is disabled.

Accepted values: KeepSessionState, DisconnectActiveSessions, ResetAllSessions.

Possible values: KeepSessionState, DisconnectActiveSessions, ResetAllSessions 

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

- End <DateTime>
The job end time 

        Required?                    true
        Position?                    named
        Default value                01/01/0001 12:00:00 AM
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Name <string>
Scheduler job name. 

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

- TargetType < SchedTargetType >
Scheduler job target type. Accepted values: Server, ServerGroup.

Possible values: Server, ServerGroup 

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

- Description <string>
Scheduler job description. 

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

- Start <DateTime>
Start time. 

        Required?                    true
        Position?                    named
        Default value                01/01/0001 12:00:00 AM
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Repeat < RepeatType >
Repeat interval.

Accepted values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear.

Possible values: Never, EveryDay, EveryWeek, Every2Weeks, EveryMonth, EveryYear 

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

- Message <string>
A message that should be sent to users before the job starts. 

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

- SendMsgBeforeMins <uint>
Time interval in minutes before the job starts when the message to users should be sent. 

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

- SiteId <uint>
The site ID to which to add the scheduler job.

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

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

- TargetServer < RDS >
The target RD Session Host server if the TargetType parameter is set to 'Server'. 

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

- TargetGroup < RDS >
The target server group if the TargetType parameter is set to ServerGroup. 

        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

PSAdmin.RDSSchedItem

EXAMPLES


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

New-RDSScheduleDisable

Creates a new schedule job with the specified settings.

RELATED LINKS