Set-RDSScheduleReboot

Set-RDSScheduleReboot

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

Set-RDSScheduleReboot [-Name] <string> [[-SiteId] <uint>] [-CompleteInSec <uint>] [-Description <string>] [-DrainMode <bool>] [-Enable <bool>] [-ForceRebootAfterMins <uint>] [-Message <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-Start <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleReboot [-Id] <uint> [-CompleteInSec <uint>] [-Description <string>] [-DrainMode <bool>] [-Enable <bool>] [-ForceRebootAfterMins <uint>] [-Message <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-Start <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

Set-RDSScheduleReboot [-InputObject] <RDSSchedItem> [-CompleteInSec <uint>] [-Description <string>] [-DrainMode <bool>] [-Enable <bool>] [-ForceRebootAfterMins <uint>] [-Message <string>] [-NewName <string>] [-Repeat <RepeatType> {Never | EveryDay | EveryWeek | Every2Weeks | EveryMonth | EveryYear}] [-SendMsgBeforeMins <uint>] [-Start <DateTime>] [-TargetGroup <RDSGroup>] [-TargetServer <RDS>] [<CommonParameters>]

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

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-CompleteInSec <uint>
Complete in (seconds).

        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

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

        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

-Start <DateTime>
Scheduler job start time.

        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

-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

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

PSAdmin.RDSSchedItem

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

Set-RDSScheduleReboot -Id 4 -Enable $false

Disables the scheduler job specified by ID.