Set-RDSScheduleDisable

Set-RDSScheduleDisable

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

Set-RDSScheduleDisable [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-DisableAction <DisableAction> {KeepSessionState | DisconnectActiveSessions | ResetAllSessions}] [-Enabled <bool>] [-EndDateTime <DateTime>] [-EnforceOnInactive <bool>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleDisable [-Id] <uint> [-Description <string>] [-DisableAction <DisableAction> {KeepSessionState | DisconnectActiveSessions | ResetAllSessions}] [-Enabled <bool>] [-EndDateTime <DateTime>] [-EnforceOnInactive <bool>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleDisable [-InputObject] <RDSSchedItem> [-Description <string>] [-DisableAction <DisableAction> {KeepSessionState | DisconnectActiveSessions | ResetAllSessions}] [-Enabled <bool>] [-EndDateTime <DateTime>] [-EnforceOnInactive <bool>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

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

-DisableAction <DisableAction>
Action that should be performed when a server is disabled.

Accepted values: KeepSessionState, DisconnectActiveSessions, ResetAllSessions.

Possible values: KeepSessionState, DisconnectActiveSessions, ResetAllSessions

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EndDateTime <DateTime>
The job end time.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-End <DateTime>
The job end time.

This is an alias of the EndDateTime parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string>
The target scheduler job name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
Site ID in which to modify the specified scheduler job.

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

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint>
The ID of the target scheduler job. To obtain the ID, use the Get-RDSSchedule cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <RDSSchedItem>
An object of type RDSSchedItem representing the target scheduler job.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-Enabled <bool>
Whether to enable or disable the scheduler job.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enable <bool>
Whether to enable or disable the scheduler job.

This is an alias of the Enabled parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-NewName <string>
A new name for the scheduler job.

        Required?                    false

        Position?                    named

        Default value                

        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

-StartDateTime <DateTime>
Scheduler job start time.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Start <DateTime>
Scheduler job start time.

This is an alias of the StartDateTime parameter.

        Required?                    false

        Position?                    named

        Default value                

        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                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MessageTitle <string>
The title of the message.

        Required?                    false

        Position?                    named

        Default value                

        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                

        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

-EnforceOnInactive <bool>
Enforced the schedule even when the target is inactive.

        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. 

RDSSchedItem

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

Set-RDSScheduleDisable -Id 4 -Enabled $false

Disables a job with the specified ID.

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

Set-RDSScheduleDisable -Id 4 -StartDateTime "8/27/2019 12:30:00" -EndDateTime "8/27/2019 12:45:00"

Specifies the job start and end time.