maintenance

Available methods

Description

Provides methods to access and modify Maintenance Schedules related entities

Namespace:

maintenance

Method: assignScheduleToSystems

Description:

Assign schedule with given name to systems with given IDs. Throws a PermissionCheckFailureException when some of the systems are not accessible by the user. Throws a InvalidParameterException when some of the systems have pending actions that are not allowed in the maintenance mode.

Parameters:

  • string sessionKey

  • string scheduleName - The schedule name

  • array :

    • int - system IDs

  • array :

    • string "rescheduleStrategy" - Available:

    • Cancel - Cancel actions which are outside of the maintenance windows

    • Fail - Let assignment fail. No operation will be performed

Returns:

  • array :

    • int - number of involved systems

Method: createCalendar

Description:

Create a new Maintenance Calendar

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

  • string ical - ICal Calendar Data

Returns:

  • array :

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: createCalendarWithUrl

Description:

Create a new Maintenance Calendar

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

  • string url - download URL for ICal Calendar Data

Returns:

  • array :

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: createSchedule

Description:

Create a new Maintenance Schedule

Parameters:

  • string sessionKey

  • string name - Maintenance Schedule Name

  • string type - Schedule type: single, multi

Returns:

  • array :

  • struct - Maintenance Schedule information

    • int "id"

    • int "orgId"

    • string "name"

    • string "type"

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: createSchedule

Description:

Create a new Maintenance Schedule

Parameters:

  • string sessionKey

  • string name - Maintenance Schedule Name

  • string type - Schedule type: single, multi

  • string calendar - Maintenance Calendar Label

Returns:

  • array :

  • struct - Maintenance Schedule information

    • int "id"

    • int "orgId"

    • string "name"

    • string "type"

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: deleteCalendar

Description:

Remove a Maintenance Calendar

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

  • boolean cancelScheduledActions - Cancel Actions of affected Schedules

Returns:

  • array :

  • struct - Reschedule information

    • string "strategy" - selected strategy

    • string "for_schedule_name"

    • boolean "status"

    • string "message"

    • array "actions"

      • struct - Action information

        • int "id" - Action Id.

        • string "name" - Action name.

        • string "type" - Action type.

        • string "scheduler" - The user that scheduled the action. (optional)

        • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

        • int "prerequisite" - ID of the prerequisite Action (optional)

        • array "affected_system_ids"

          • int - affected System Ids

        • string "details" - Action details string

Method: deleteSchedule

Description:

Remove a Maintenance Schedule

Parameters:

  • string sessionKey

  • string name - Maintenance Schedule Name

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getCalendarDetails

Description:

Lookup a specific Maintenance Schedule

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

Returns:

  • array :

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: getScheduleDetails

Description:

Lookup a specific Maintenance Schedule

Parameters:

  • string sessionKey

  • string name - Maintenance Schedule Name

Returns:

  • array :

  • struct - Maintenance Schedule information

    • int "id"

    • int "orgId"

    • string "name"

    • string "type"

  • struct - Maintenance Calendar information

    • int "id"

    • int "orgId"

    • string "label"

    • string "url" - calendar url if present

    • string "ical"

Method: listCalendarLabels

Description:

List Schedule Names visible to user

Parameters:

  • string sessionKey

Returns:

  • array :

    • string - maintenance calendar labels

Method: listScheduleNames

Description:

List Schedule Names visible to user

Parameters:

  • string sessionKey

Returns:

  • array :

    • string - maintenance schedule names

Method: listSystemsWithSchedule

Description:

List IDs of systems that have given schedule assigned Throws a PermissionCheckFailureException when some of the systems are not accessible by the user.

Parameters:

  • string sessionKey

  • string scheduleName - The schedule name

Returns:

  • array :

    • int - system IDs

Method: refreshCalendar

Description:

Refresh Maintenance Calendar Data using the configured URL

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

  • array :

    • string "rescheduleStrategy" - Available:

    • Cancel - Cancel actions which are outside of the maintenance windows

    • Fail - Let update fail. The calendar stay untouched

Returns:

  • array :

  • struct - Reschedule information

    • string "strategy" - selected strategy

    • string "for_schedule_name"

    • boolean "status"

    • string "message"

    • array "actions"

      • struct - Action information

        • int "id" - Action Id.

        • string "name" - Action name.

        • string "type" - Action type.

        • string "scheduler" - The user that scheduled the action. (optional)

        • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

        • int "prerequisite" - ID of the prerequisite Action (optional)

        • array "affected_system_ids"

          • int - affected System Ids

        • string "details" - Action details string

Method: retractScheduleFromSystems

Description:

Retract schedule with given name from systems with given IDs Throws a PermissionCheckFailureException when some of the systems are not accessible by the user.

Parameters:

  • string sessionKey

  • array :

    • int - system IDs

Returns:

  • array :

    • int - number of involved systems

Method: updateCalendar

Description:

Update a Maintenance Calendar

Parameters:

  • string sessionKey

  • string label - Maintenance Calendar Label

  • struct - Maintenance Calendar Details

    • string "ical" - new ical Calendar data

    • string "url" - new Calendar URL

  • array :

    • string "rescheduleStrategy" - Available:

    • Cancel - Cancel actions which are outside of the maintenance windows

    • Fail - Let update fail. The calendar stay untouched

Returns:

  • array :

  • struct - Reschedule information

    • string "strategy" - selected strategy

    • string "for_schedule_name"

    • boolean "status"

    • string "message"

    • array "actions"

      • struct - Action information

        • int "id" - Action Id.

        • string "name" - Action name.

        • string "type" - Action type.

        • string "scheduler" - The user that scheduled the action. (optional)

        • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

        • int "prerequisite" - ID of the prerequisite Action (optional)

        • array "affected_system_ids"

          • int - affected System Ids

        • string "details" - Action details string

Method: updateSchedule

Description:

Update a Maintenance Schedule

Parameters:

  • string sessionKey

  • string name - Maintenance Schedule Name

  • struct - Maintenance Schedule Details

    • string "type" - new Schedule Type

    • single

    • multi

    • string "calendar" - new calendar label

  • array :

    • string "rescheduleStrategy" - Available:

    • Cancel - Cancel actions which are outside of the maintenance windows

    • Fail - Let update fail. The calendar stay untouched

Returns:

  • * struct - Reschedule information

    • string "strategy" - selected strategy

    • string "for_schedule_name"

    • boolean "status"

    • string "message"

    • array "actions"

      • struct - Action information

        • int "id" - Action Id.

        • string "name" - Action name.

        • string "type" - Action type.

        • string "scheduler" - The user that scheduled the action. (optional)

        • dateTime.iso8601 "earliest" - The earliest date and time the action will be performed

        • int "prerequisite" - ID of the prerequisite Action (optional)

        • array "affected_system_ids"

          • int - affected System Ids

        • string "details" - Action details string