Endpoint
/api/v2/tenants/{tenantId}/scheduleMaintenances
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

alertConditions
object

(Optional) For specific alerts to be triggered as maintenance alerts, configure the below alert conditions. Alerts that do match with the below conditions are triggered as monitoring alerts: 1. Alert conditions should match ALL or ANY of the rules. 2. Conditions for filter alerts: 1. Unique attribute of alert. 2. Logical operators to filter alertsSupported values: Equals, NotEquals, Equals, NotEquals, Startswith, Endswith, Regex. See Regular Expressions to filter alerts with operator Regex. 3. Unique data of alert. Example: Cloud Controller Discovery

alertConditions.matchingType
alertConditions.rules
description
string

Schedule description.

deviceGroups
array

Details of resources which should be added to schedule maintenance window. No more than 100 resources can be added to a schedule maintenance window.

deviceGroups.id
deviceGroups.name
devices
array

Details of resources which should be added to schedule maintenance window. No more than 100 resources can be added to a schedule maintenance window.

devices.hostName
devices.uniqueId
endBy
string

(Optional) Maintenance ending schedule. 1. For a recurring schedule maintenance to be perpetual, provide endBy: NEVER. In this case, time specified in the field endTime is the scheduled end time. (The date is *not* considered by the API.) To assign a schedule maintenance to run on alternate days, it starts at 8 AM and ends at 5:30 PM. Maintenance is to be set as a repetitive process that never ends. The values provided are: ``` "schedule": { "type": "Recurring", "startTime": "2018-05-28T08:00:00+0000", "endTime": "2018-10-29T17:30:00+0000", "timezone": "America/Puerto_Rico", "pattern": "type": "daily", "dayFrequency": "everyday" "repeatFrequency": 1 "endBy": "Never" } } ``` 2. For a recurring schedule maintenance to end at a specific time period, provide the end date and time in the field endTime. Example: "2016-05-29T18:55:27+0000"

installPatch
boolean

(Optional) Set installPatch=true to install patch; otherwise, set to false.

locations
array

Details of resources which should be added to schedule maintenance window. No more than 100 resources can be added to a schedule maintenance window.

locations.id
locations.name
name
string

Schedule name.

runEscalationAction
boolean

(Optional) Provide runEscalationAction: true to escalate maintenance alerts after schedule maintenance is completed. If no value is provided, the default value is true.

runRBA
boolean

(Optional) Set runRBA=true to run RBA scripts; otherwise, set to false.

schedule
object

Schedule details:

schedule.endTime
Time at which the schedule activity should end.
schedule.pattern
Schedule pattern:
schedule.startTime
Time at which the schedule activity should begin.
schedule.timezone
Timezone in which the schedule should operate. (The list of timezones are shown below.) Example: "timezone": "America/Puerto_Rico"
schedule.type
Schedule type.
{
  "description": "Recurring-dailyeverydayschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": "false",
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-dailyeverydayschedule",
  "runRBA": "false",
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayFrequency": "every weekday",
      "type": "daily"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}
{
  "description": "Recurring-monthly-1schedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_4"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": "false",
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-monthly-1schedule",
  "runRBA": "false",
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayOfMonth": "14",
      "type": "monthly"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}
{
  "description": "Recurring-monthly-2schedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_2"
    },
    {
      "id": "10"
    }
  ],
  "installPatch": "false",
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-monthly-2schedule",
  "runRBA": "false",
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "dayOfWeek": "Thursday",
      "type": "monthly",
      "weekIndex": "Third"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Los_Angeles",
    "type": "Recurring"
  }
}
{
  "description": "Onetimeschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "device-1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": "false",
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Onetimeschedule",
  "runRBA": "false",
  "schedule": {
    "endTime": "2016-05-29T18:55:27+0000",
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/New_York",
    "type": "One-Time"
  }
}
{
  "description": "Recurring-weeklyschedule",
  "deviceGroups": [
    {
      "name": "DG-1"
    },
    {
      "id": "11"
    }
  ],
  "devices": [
    {
      "hostName": "Device_1"
    },
    {
      "uniqueId": "90491678-096c-4223-9867-f31c37ff09da"
    }
  ],
  "installPatch": "false",
  "locations": [
    {
      "name": "LOC-1"
    },
    {
      "id": "12"
    }
  ],
  "name": "Recurring-weeklyschedule",
  "runRBA": "false",
  "schedule": {
    "endTime": "2015-05-29T18:55:27+0000",
    "pattern": {
      "type": "weekly",
      "weekDays": "Wednesday,Thursday"
    },
    "startTime": "2015-05-28T10:55:27+0000",
    "timezone": "America/Puerto_Rico",
    "type": "Recurring"
  }
}

Responses

OK

uniqueId
string

{
  "uniqueId": "SM-d21b6b44-c85a-426c-9963-0e977070ce98"
}