manual:maintenance

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:maintenance [2019/06/10 07:26]
martins-v some rewording
manual:maintenance [2020/09/24 08:35] (current)
marinagen [ZBXNEXT-6194] Improved description of maintenance periods
Line 25: Line 25:
 If a timestamped value is sent for a host that is in a “no data” maintenance type (e.g. using [[manpages:​zabbix_sender|Zabbix sender]]) then this value will be dropped however it is possible to send a timestamped value in for an expired maintenance period and it will be accepted. ​ If a timestamped value is sent for a host that is in a “no data” maintenance type (e.g. using [[manpages:​zabbix_sender|Zabbix sender]]) then this value will be dropped however it is possible to send a timestamped value in for an expired maintenance period and it will be accepted. ​
  
-<note important>​To ensure predictable behaviour of recurring maintenance periods (daily, weekly, monthly), it is required to use a common ​timezone ​for all parts of Zabbix.</​note>​+<note important>​To ensure predictable behaviour of recurring maintenance periods (daily, weekly, monthly), it is required to use a common ​time zone for all parts of Zabbix.</​note>​
  
-If maintenance period, hosts, groups or tags are changed by user, the changes will only take effect after configuration cache synchronization.+If maintenance period, hosts, groups or tags are changed by the user, the changes will only take effect after configuration cache synchronization.
 === Configuration === === Configuration ===
  
Line 35: Line 35:
   * Click on //Create maintenance period// (or on the name of an existing maintenance period)   * Click on //Create maintenance period// (or on the name of an existing maintenance period)
  
-The **Maintenance** ​tab contains general maintenance period attributes:+Fill out the **Maintenance ​periods** configuration form:
  
-{{manual:​maintenance:​maintenance_general.png|}}+{{manual:​maintenance:​maintenance_onetab.png?600|}}
  
 All mandatory input fields are marked with a red asterisk. ​ All mandatory input fields are marked with a red asterisk. ​
Line 44: Line 44:
 |//​Name// ​ |Name of the maintenance period. | |//​Name// ​ |Name of the maintenance period. |
 |//​Maintenance type// ​ |Two types of maintenance can be set:\\ **With data collection** - data will be collected by the server during maintenance,​ triggers will be processed\\ **No data collection** - data will not be collected by the server during maintenance | |//​Maintenance type// ​ |Two types of maintenance can be set:\\ **With data collection** - data will be collected by the server during maintenance,​ triggers will be processed\\ **No data collection** - data will not be collected by the server during maintenance |
-|//Active since// ​ |The date and time when executing maintenance periods becomes active.\\ //Note//: Setting this time alone does not activate a maintenance period; for that go to the //Periods// tab.  | +|//Active since// ​     |The date and time when executing maintenance periods becomes active.\\ //Note//: Setting this time alone does not activate a maintenance period; for that go to the //Periods// tab.  | 
-|//Active till// ​ |The date and time when executing maintenance periods stops being active. ​ | +|//Active till// ​      ​|The date and time when executing maintenance periods stops being active. ​ | 
-|//Description//  |Description of maintenance period. |+|//Periods// ​          |This block allows you to define the exact days and hours when the maintenance takes place. Clicking on {{:​manual:​maintenance:​add_link.png|}} opens a popup window with a flexible //​Maintenance period// form where you can define maintenance schedule. See [[#​maintenance_periods|Maintenance periods]] for a detailed description. | 
 +|//Host groups//  ​|Select host groups that the maintenance will be activated for. The maintenance will be activated for all hosts from the specified host group(s). This field is auto-complete,​ so starting to type in it will display a dropdown of all available host groups.\\ Specifying a parent host group implicitly selects all nested host groups. Thus the maintenance will also be activated on hosts from nested groups. ​ | 
 +|//​Hosts// ​ |Select hosts that the maintenance will be activated for. This field is auto-complete,​ so starting to type in it will display a dropdown of all available hosts.\\ ​ | 
 +|//​Tags// ​  |If maintenance tags are specified, maintenance for the selected hosts will still be activated, but problems will only be suppressed (i.e. no actions will be taken) if their tags are a match.\\ In case of multiple tags, they are calculated as follows:\\ **And/Or** - all tags must correspond; however tags with the same tag name are calculated by the Or condition\\ **Or** - enough if one tag corresponds\\ There are two ways of matching the tag value:\\ **Contains** - case-sensitive substring match (tag value contains the entered string)\\ **Equals** - case-sensitive string match (tag value equals the entered string) ​ | 
 +|//​Description// ​      |Description of maintenance period. |
  
-The **Periods** tab allows you to define the exact days and hours when the maintenance ​takes place. Clicking on //New// opens a flexible //​Maintenance ​period// form where you can define the times - for daily, weekly, monthly ​or one-time maintenance.+  
 +== Maintenance periods == 
 +The maintenance period ​window is for scheduling time for a recurring ​or one-time maintenance. The form is dynamic with available fields changing based on the //Period type// selected
  
-{{manual:​maintenance:​maintenance_periods.png|}}+{{manual:​maintenance:​maintenance_period0.png|}}
  
-Daily and weekly periods have an //Every day/Every week// ​parameter, which defaults to 1. Setting it to would make the maintenance take place every two days or every two weeks and so onThe starting day or week is the day or week that //Active since// time falls on.+^Period type^Description 
 +| One time only | Define the date and time, and the length of the maintenance period. | 
 +| Daily         ​| ​//Every day(s)// - maintenance frequency: 1 (default) - every day, 2 - every two days, etc. \\ //At (hour:​minute)//​ - time of the day when maintenance starts \\ //​Maintenance period length// - for how long the maintenance will be active. | 
 +|Weekly ​        | //Every week(s)// - maintenance frequency: ​(default) - every day, - every two days, etc. \\ //Day of week// - on which day the maintenance ​should ​take place. \\ //At (hour:​minute)//​ - time of the day when maintenance starts \\ //​Maintenance period length// - for how long the maintenance will be active.| 
 +|Monthly ​       | //Month// - select all months during which the regular maintenance is carried out. \\ //Date//: **Day of month** - Select this option if the maintenance takes place on the same date each month (for example, ​every 1st day of the month). Then, select the required day in the new field that appears. \\ /Date//: **Day of week** - Select this option if the maintenance takes place only on certain ​days (for example, ​every first Monday of the month)Then, in the drop-down select the required ​week of the month (first, second, third, fourth, ​or last) and mark the checkboxes for maintenance day(s). \\ //At (hour:​minute)// time of the day when maintenance starts \\ //​Maintenance period length// - for how long the maintenance will be active.|
  
-For examplehaving ​//Active since// set to 2013-09-06 12:00 and an hour long daily recurrent period every two days at 23:00 will result in the first maintenance period ​starting on 2013-09-06 at 23:00, while the second maintenance period will start on 2013-09-08 at 23:00. Or, with the same //Active since// time and an hour long daily recurrent period every two days at 01:00, the first maintenance period will start on 2013-09-08 at 01:00, and the second maintenance period on 2013-09-10 at 01:00.+When donepress //Add// to add the maintenance period ​to the //Periods// block.
  
-The **Hosts and groups** tab allows you to select the host groups, hosts and problem tags for maintenance.+Notes:
  
-{{manual:​maintenance:​maintenance_groups_hosts1.png|}}+  * When //Every day/Every week// parameter is greater than 1, the starting day or week is the day/week that the //Active since// time falls on. For example: 
 +    * with //Active since// set to January 1st at 12:00 and a one-hour ​maintenance ​set for every two days at 11pm will result in the first maintenance period starting on January 1st at 11pm, while the second maintenance period will start on January 3rd at 11pm; 
 +    * with the same //Active since// time and a one-hour maintenance set for every two days at 1am, the first maintenance period will start on January 3rd at 1am, while the second maintenance period will start on January 5th at 1am. 
 +  * Daylight Saving Time (**DST**) changes do not affect how long the maintenance will be. Let's say we have a two-hour maintenance that usually starts at 1am and finishes at 3am: 
 +    * If after one hour of maintenance (at 2am) a DST change happens and current time changes from 2:00 to 3:00, the maintenance will continue for one more hour till 4:00; 
 +    * If after two hours of maintenance (at 3am) a DST change happens and current time changes from 3:00 to 2:00, the maintenance will stop because two hours have passed.
  
-^Parameter^Description^ 
-|//Host groups// ​ |Select host groups that the maintenance will be activated for. The maintenance will be activated for all hosts from the specified host group(s). This field is auto-complete,​ so starting to type in it will display a dropdown of all available host groups.\\ Specifying a parent host group implicitly selects all nested host groups. Thus the maintenance will also be activated on hosts from nested groups. ​ | 
-|//​Hosts// ​ |Select hosts that the maintenance will be activated for. This field is auto-complete,​ so starting to type in it will display a dropdown of all available hosts.\\ ​ | 
-|//​Tags// ​  |If maintenance tags are specified, maintenance for the selected hosts will still be activated, but problems will only be suppressed (i.e. no actions will be taken) if their tags are a match.\\ In case of multiple tags, they are calculated as follows:\\ **And/Or** - all tags must correspond; however tags with the same tag name are calculated by the Or condition\\ **Or** - enough if one tag corresponds\\ There are two ways of matching the tag value:\\ **Contains** - case-sensitive substring match (tag value contains the entered string)\\ **Equals** - case-sensitive string match (tag value equals the entered string) ​ | 
  
 === Display === === Display ===