The following objects are directly related to the maintenance
API.
The maintenance object has the following properties.
Property | Type | Description |
---|---|---|
maintenanceid | ID | ID of the maintenance. Property behavior: - read-only - required for update operations |
name | string | Name of the maintenance. Property behavior: - required for create operations |
active_since | timestamp | Time when the maintenance becomes active. The given value will be rounded down to minutes. Property behavior: - required for create operations |
active_till | timestamp | Time when the maintenance stops being active. The given value will be rounded down to minutes. Property behavior: - required for create operations |
description | string | Description of the maintenance. |
maintenance_type | integer | Type of maintenance. Possible values: 0 - (default) with data collection; 1 - without data collection. |
tags_evaltype | integer | Problem tag evaluation method. Possible values: 0 - (default) And/Or; 2 - Or. |
The time period object is used to define periods when the maintenance must come into effect. It has the following properties.
Property | Type | Description |
---|---|---|
period | integer | Duration of the maintenance period in seconds. The given value will be rounded down to minutes. Default: 3600. |
timeperiod_type | integer | Type of time period. Possible values: 0 - (default) one time only; 2 - daily; 3 - weekly; 4 - monthly. |
start_date | timestamp | Date when the maintenance period must come into effect. The given value will be rounded down to minutes. Default: current date. Property behavior: - supported if timeperiod_type is set to "one time only" |
start_time | integer | Time of day when the maintenance starts in seconds. The given value will be rounded down to minutes. Default: 0. Property behavior: - supported if timeperiod_type is set to "daily", "weekly", or "monthly" |
every | integer | For daily and weekly periods every defines the day or week intervals at which the maintenance must come into effect.Default value if timeperiod_type is set to "daily" or "weekly": 1.For monthly periods when day is set, the every property defines the day of the month when the maintenance must come into effect.Default value if timeperiod_type is set to "monthly" and day is set: 1.For monthly periods when dayofweek is set, the every property defines the week of the month when the maintenance must come into effect.Possible values if timeperiod_type is set to "monthly" and dayofweek is set:1 - (default) first week; 2 - second week; 3 - third week; 4 - fourth week; 5 - last week. Property behavior: - supported if timeperiod_type is set to "daily", "weekly", or "monthly" |
dayofweek | integer | Days of the week when the maintenance must come into effect. Days are stored in binary form with each bit representing the corresponding day. For example, 4 equals 100 in binary and means, that maintenance will be enabled on Wednesday. Property behavior: - required if timeperiod_type is set to "weekly", or if timeperiod_type is set to "monthly" and day is not set- supported if timeperiod_type is set to "monthly" |
day | integer | Day of the month when the maintenance must come into effect. Property behavior: - required if timeperiod_type is set to "monthly" and dayofweek is not set- supported if timeperiod_type is set to "monthly" |
month | integer | Months when the maintenance must come into effect. Months are stored in binary form with each bit representing the corresponding month. For example, 5 equals 101 in binary and means, that maintenance will be enabled in January and March. Property behavior: - required if timeperiod_type is set to "monthly" |
The problem tag object is used to define which problems must be suppressed when the maintenance comes into effect. Tags can only be specified if maintenance_type
of Maintenance object is set to "with data collection". It has the following properties.
Property | Type | Description |
---|---|---|
tag | string | Problem tag name. Property behavior: - required |
operator | integer | Condition operator. Possible values: 0 - Equals; 2 - (default) Contains. |
value | string | Problem tag value. |