Set-RDSScheduleReboot

NAME

Set-RDSScheduleReboot

SYNOPSIS

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

SYNTAX

Set-RDSScheduleReboot [-Name] <string> [[-SiteId] <uint>] [-CompleteRebootInSecs <uint>] [-Description <string>] [-DrainMode <bool>] [-Enabled <bool>] [-EnforceOnInactive <bool>] [-ForceRebootDelayMins <uint>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleReboot [-Id] <uint> [-CompleteRebootInSecs <uint>] [-Description <string>] [-DrainMode <bool>] [-Enabled <bool>] [-EnforceOnInactive <bool>] [-ForceRebootDelayMins <uint>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleReboot [-InputObject] <RDSSchedItem> [-CompleteRebootInSecs <uint>] [-Description <string>] [-DrainMode <bool>] [-Enabled <bool>] [-EnforceOnInactive <bool>] [-ForceRebootDelayMins <uint>] [-Message <string>] [-MessageTitle <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-StartDateTime <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

DESCRIPTION

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

PARAMETERS


-DrainMode <bool>
Whether to enable or disable the Drain mode. 

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

-ForceRebootDelayMins <uint>
Force reboot after (in minutes). 

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

-ForceRebootAfterMins <uint>
Force reboot after (in minutes).

This is an alias of the ForceRebootDelayMins parameter. 

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

-CompleteRebootInSecs <uint>
Complete in (seconds). 

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

-CompleteInSecs <uint>
Complete in (seconds).

This is an alias of the CompleteRebootInSecs 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.

INPUTS

RDSSchedItem

OUTPUTS

-none-

EXAMPLES


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

Set-RDSScheduleReboot -Id 4 -Enabled $false

Disables the scheduler job specified by ID.

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

Set-RDSScheduleReboot -Name "schedule_job" -StartDateTime "11/06/2019 16:55:04"

Modifies the startup time for the scheduler job specified by name.

RELATED LINKS