tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-29 16:44:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6733 from Icinga/bugfix/doc-comment-entry_time

Browse Source 
Doc: warn about not setting Comment#entry_time
This commit is contained in:
Michael Friedrich 2018-10-30 13:43:17 +01:00 committed by GitHub
commit 0cde5b92b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/09-object-types.md
View File

@ -297,6 +297,7 @@ object Comment "localhost!my-comment" {
host_name = "localhost" host_name = "localhost"
author = "icingaadmin" author = "icingaadmin"
text = "This is a comment." text = "This is a comment."
entry_time = 1234567890
} }
``` ```
@ -308,7 +309,7 @@ Configuration Attributes:
service\_name | Object name | **Optional.** The short name of the service this comment belongs to. If omitted, this comment object is treated as host comment. service\_name | Object name | **Optional.** The short name of the service this comment belongs to. If omitted, this comment object is treated as host comment.
author | String | **Required.** The author's name. author | String | **Required.** The author's name.
text | String | **Required.** The comment text. text | String | **Required.** The comment text.
entry\_time | Timestamp | **Optional.** The UNIX timestamp when this comment was added. entry\_time | Timestamp | **Optional.** The UNIX timestamp when this comment was added. If omitted, the entry time is volatile!
entry\_type | Number | **Optional.** The comment type (`User` = 1, `Downtime` = 2, `Flapping` = 3, `Acknowledgement` = 4). entry\_type | Number | **Optional.** The comment type (`User` = 1, `Downtime` = 2, `Flapping` = 3, `Acknowledgement` = 4).
expire\_time | Timestamp | **Optional.** The comment's expire time as UNIX timestamp. expire\_time | Timestamp | **Optional.** The comment's expire time as UNIX timestamp.
persistent | Boolean | **Optional.** Only evaluated for `entry_type` Acknowledgement. `true` does not remove the comment when the acknowledgement is removed. persistent | Boolean | **Optional.** Only evaluated for `entry_type` Acknowledgement. `true` does not remove the comment when the acknowledgement is removed.