Reboot

PreviousMessages NextShutdown

Was this helpful?

Create Reboot

post

Creates a new Reboot Schedule.

Body

namestring | nullablerequired

<para type="description">Schedule name.</para>

siteIdinteger · int32

<para type="description">Site ID from which to retrieve the schedule.</para>

enabledboolean | nullable

<para type="description">Whether to enable or disable the schedule.</para>

descriptionstring | nullable

<para type="description">Schedule description.</para>

typeinteger · int32 | nullable

<para type="description">Schedule type</para>

startDateTimestring · date-time

<para type="description">Start time. Default: Now.</para>

durationInSecsnumber · double | nullable

<para type="description">Duration in seconds.</para>

repeatstring · enum

<para type="synopsis">Repeat Type</para> <para type="description"></para>

Options: 0 = Never,1 = EveryDay,2 = EveryWeek,3 = Every2Weeks,4 = EveryMonth,5 = EveryYear,6 = SpecificDays

specificDaysstring[Flag] · enum

<para type="synopsis">Repeat Specific Days</para> <para type="description"></para>

Options: 0 = Never,1 = Sunday,2 = Monday,4 = Tuesday,8 = Wednesday,16 = Thursday,32 = Friday,64 = Saturday

completeIninteger · int32 | nullable

<para type="description">The duration of the scheduler task in minutes. </para> <para type="description">Default: 15 minutes for disable task, 10 minutes for reboot task.</para>

poolMembersTypeinteger · int32 | nullable

<para type="description">Whether to select the percentage or specific number of members to be started</para>

percentageMembersinteger · int32 | nullable

<para type="description">Percentage of members to be started</para>

membersToStartinteger · int32 | nullable

<para type="description">Specific number of members to be started</para>

powerOnAssignedPoolMembersinteger · int32 | nullable

<para type="description">Power On Assigned Pool Members</para>

enableDrainModeboolean | nullable

<para type="description">Whether to enable Drain Mode</para>

forceServerRebootAfterinteger · int32 | nullable

<para type="description">Force server reboot after the specified time in seconds</para>

enforceScheduleInactiveHostboolean | nullable

<para type="description">Enforce schedule for currently inactive host</para>

onDisableboolean | nullable

<para type="description">What action to take on Disable</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDS/Host/Schedule/Reboot' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "enabled": true,
    "description": "text",
    "type": 1,
    "startDateTime": "2025-03-20T06:03:37.795Z",
    "durationInSecs": 1,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "completeIn": 1,
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }'

200

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-20T06:03:37.795Z",
  "timeLastMod": "2025-03-20T06:03:37.795Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-03-20T06:03:37.795Z",
    "endDateTime": "2025-03-20T06:03:37.795Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Success