maintenance.create

Description

object maintenance.create(object/array maintenances)

This method allows to create new maintenances.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Maintenances to create.

Additionally to the standard maintenance properties, the method accepts the following parameters.

ParameterTypeDescription
groupsobject/arrayHost groups that will undergo maintenance.

The host groups must have the groupid property defined.

Parameter behavior:
- required if hosts is not set
hostsobject/arrayHosts that will undergo maintenance.

The hosts must have only the hostid property defined.

Parameter behavior:
- required if groups is not set
timeperiodsobject/arrayMaintenance time periods.

Parameter behavior:
- required
tagsobject/arrayProblem tags.

Define what problems must be suppressed.
If no tags are given, all active maintenance host problems will be suppressed.

Parameter behavior:
- supported if maintenance_type of Maintenance object is set to “with data collection”
groupids
(deprecated)		arrayThis parameter is deprecated, please use groups instead.
IDs of the host groups that will undergo maintenance.
hostids
(deprecated)		arrayThis parameter is deprecated, please use hosts instead.
IDs of the hosts that will undergo maintenance.

Return values

(object) Returns an object containing the IDs of the created maintenances under the maintenanceids property. The order of the returned IDs matches the order of the passed maintenances.

Examples

Creating a maintenance

Create a maintenance with data collection for host group with ID “2” and with problem tags service:mysqld and error. It must be active from 22.01.2013 till 22.01.2014, come in effect each Sunday at 18:00 and last for one hour.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "maintenance.create",
  4.            "params": {
  5.                "name": "Sunday maintenance",
  6.                "active_since": 1358844540,
  7.                "active_till": 1390466940,
  8.                "tags_evaltype": 0,
  9.                "groups": [
  10.                    {"groupid": "2"}
  11.                ],
  12.                "timeperiods": [
  13.                    {
  14.                        "period": 3600,
  15.                        "timeperiod_type": 3,
  16.                        "start_time": 64800,
  17.                        "every": 1,
  18.                        "dayofweek": 64
  19.                    }
  20.                ],
  21.                "tags": [
  22.                    {
  23.                        "tag": "service",
  24.                        "operator": "0",
  25.                        "value": "mysqld"
  26.                    },
  27.                    {
  28.                        "tag": "error",
  29.                        "operator": "2",
  30.                        "value": ""
  31.                    }
  32.                ]
  33.            },
  34.            "id": 1
  35.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": {
  4.                "maintenanceids": [
  5.                    "3"
  6.                ]
  7.            },
  8.            "id": 1
  9.        }

See also

Source

CMaintenance::create() in ui/include/classes/api/services/CMaintenance.php.