Get schedule maintenance window

This endpoint is used to retrieve the details of a scheduled maintenance window.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/scheduleMaintenances/{smId}

Sample URLs

https://{api-url}/api/v2/tenants/client_8/scheduleMaintenances/SM-c11b6b44-c85a-426c-9963-0e977070ce98

Schedule maintenance patterns

Schedule maintenance: one-time

One-time schedule maintenance would cause the resource to initiate the tasks for a particular period of time. Define the start date and end date for maintenance:

"schedule": {
		"type": "one-time",
		"startTime": "2016-08-11T10:00:00+0000",
		"endTime": "2016-08-15T23:00:00+0000"
}

Date format is yyyy-MM-ddTHH:mm:ssZ (GMT).

Schedule maintenance: recurring

Schedule PatternFieldsDescription
DailySelected day:
  • "type" : "daily",
  • "dayFrequency": "everyday",
  • "repeatFrequency" : 2
Maintenance tasks are performed on certain days.
Example: If repeatFrequency is 2, then the maintenance task is performed for every two days.
Every weekday:
  • "dayFrequency": "every weekday"
Maintenance tasks are performed every week from Monday to Friday.
WeeklyWeekdays:
  • "type" : "weekly",
  • "weekDays": "Monday, Tuesday"
Weekday on which maintenance tasks are performed. Supported weekdays are from Sunday to Saturday.
MonthlyDay of every month:
  • "type" : "monthly",
  • "dayOfMonth": "02,03"
Maintenance tasks are performed on certain days of every month. From the sample values provided, resources are scheduled for maintenance on the second and third day of every month.
Weekday of every month:
  • "type" : "monthly",
  • "weekIndex" : "Last",
  • "dayOfWeek": "Saturday"
Weekday on which the maintenance tasks are performed. From the sample values provided, resources are scheduled for maintenance on the last Saturday of every month.

Schedule maintenance: daily

Everyday:

"schedule": {
		"type": "recurring",
		"startTime": "2017-05-05T09:00:00+0000",
		"endTime": "2017-05-11T18:00:00+0000",
		"pattern": {
			"type": "daily",
			"dayFrequency": "everyday",
			"repeatFrequency": 2
		}
}

Every weekday:

"schedule": {
		"type": "recurring",
		"startTime": "2017-05-05T14:00:00+0000",
		"endTime": "2017-05-11T16:00:00+0000",
		"pattern": {
			"type": "daily",
			"dayFrequency": "every weekday"
		}
}

Schedule maintenance: weekly

Weekdays:

"schedule": {
		"type": "recurring",
		"startTime": "2017-05-05T13:00:00+0000",
		"endTime": "2017-05-25T19:00:00+0000",
		"pattern": {
			"type": "weekly",
			"weekDays": "Monday,Tuesday"
		}
}

Schedule maintenance: monthly

Day of every month:

"schedule": {
		"type": "recurring",
		"startTime": "2017-05-05T03:00:00+0000",
		"endTime": "2017-05-17T11:00:00+0000",
		"pattern": {
			"type": "monthly",
			"weekIndex": "Last",
			"dayOfWeek": "Saturday"
		}
}

Weekday of every month:

"schedule": {
		"type": "recurring",
		"startTime": "2017-05-05T04:00:00+0000",
		"endTime": "2017-05-24T13:00:00+0000",
		"pattern": {
			"type": "monthly",
			"dayOfMonth": "02,03"
		}
}

Sample response

{
	"uniqueId": "SM-d765c8d5-7df6-49ec-9bb0-4cd82b945c96",
	"name": "Under Maintenance",
	"dontRunRBA": "true",
	"dontInstallPatch": "true",
	"runRBA": false,
	"installPatch": false,
	"createdTime": "2017-08-11T06:19:09+0000",
	"updatedTime": "2017-11-02T11:08:52+0000",
	"schedule": {
		"type": "one-time",
		"startTime": "2017-08-11T10:00:00+0000",
		"endTime": "2017-08-15T23:00:00+0000"
	},
	"devices": [{
			"id": "edd5e6db-3e7f-4292-9e7f-ab1532ce3b6c",
			"generalInfo": {
				"osName": "Microsoft(R) Windows(R) Server 2003, Enterprise Edition Service Pack 2",
				"ipAddresses": "172.26.103.1",
				"hostName": "172.26.103.1"
			},
			"clientUniqueId": "client_8",
			"type": "DEVICE"
		},
		{
			"id": "12f2deff-f3ca-47f6-bb5d-3b9292dd8a0b",
			"generalInfo": {
				"osName": "Microsoft Windows Server 2008 R2 Datacenter Edition Service Pack 1, 64-bit",
				"ipAddresses": "10.6.0.4",
				"hostName": "AZR-OS-1"
			},
			"clientUniqueId": "client_8",
			"type": "DEVICE"
		}
	],
	"deviceGroups": [{
		"name": "SJ-WINDOWS",
		"description": "Windows Systems at SJ",
		"createdTime": 1469345264000,
		"updatedTime": 1469345595000
	}],
	"locations": [{
			"id": 3,
			"name": "SJ-AD LAB",
			"clientId": 8,
			"mspId": 6,
			"description": "SJ Lab",
			"address": "Parkway",
			"city": "San Jose",
			"state": "California",
			"country": "United States",
			"phoneNumber": "",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "opsLab@luminalto.com",
				"lastName": "Lab",
				"firstName": "ops",
				"email": "john.smith@luminalto.com",
				"phoneNumber": "408-555-1234"
			}
		},
		{
			"id": 5,
			"name": "SJ-EAST LAB",
			"clientId": 8,
			"mspId": 6,
			"description": "East Labs",
			"address": "Blossom Valley",
			"city": "San Jose",
			"state": "California",
			"country": "United States",
			"phoneNumber": "408-555-1230",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "opsLab@luminalto.com",
				"lastName": "Lab",
				"firstName": "ops",
				"email": "john.smith@luminalto.com",
				"phoneNumber": "408-555-1234"
			}
		}
	],
	"status": "Completed"
}