AutoUpgrade

Get

Retrieve the Auto-upgrade settings of a session server with the specified ID.

GET/api/RDS/HostPool/{id}/AutoUpgrade

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the Auto-upgrade settings.

Response

200401404

Success

Body

application/json; api-version=1.0

enabledboolean

Enable auto-upgrade maintenance window

startDateTimestring (date-time)

Start Date

drainModeDurationInSecsnumber (double)

Drain mode duration

forceLogoffSessionsboolean

Force logoff sessions at the end of the drain mode period

repeatRepeatType (enum)

Repeat Type

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

specificDaysRepeatSpecificDays (enum)

Repeat Specific Days

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

messagesnullable array of ScheduleMessage (object)

Messages

Request

JavaScriptCurlPython

const response = await fetch('/api/RDS/HostPool/{id}/AutoUpgrade', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "enabled": false,
  "startDateTime": "2024-11-07T07:36:50.486Z",
  "drainModeDurationInSecs": 0,
  "forceLogoffSessions": false,
  "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"
  ],
  "messages": [
    {
      "enabled": false,
      "messageTitle": "text",
      "message": "text",
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

Update

Update the Auto-upgrade settings of a session server with the specified ID.

PUT/api/RDS/HostPool/{id}/AutoUpgrade

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Auto-upgrade settings.

Body

application/json; api-version=1.0

Auto-upgrade settings.

SetAutoUpgrade (object)

Modify the Auto-upgrade settings

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/RDS/HostPool/{id}/AutoUpgrade', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}