Update documentation.

This commit is contained in:
Gunnar Beutner 2013-10-18 15:10:34 +02:00
parent 51bbb60156
commit 63fd3e1581
2 changed files with 21 additions and 9 deletions

View File

@ -214,8 +214,8 @@ Attributes:
display_name |**Optional.** A short description of the user.
macros |**Optional.** A dictionary containing macros that are specific to this user.
custom |**Optional.** A dictionary containing custom attributes that are specific to this user.
groups |TODO
enable_notifications|TODO
groups |**Optional.** An array of group names.
enable_notifications|**Optional.** Whether notifications are enabled for this user.
notification_period|TODO
notification_type_filter|TODO
notification_state_filter|TODO
@ -655,18 +655,28 @@ TODO
Example:
TODO
library "cluster"
object ClusterListener "cluster" {
ca_path = "/etc/icinga2/ca/ca.crt",
cert_path = "/etc/icinga2/ca/icinga-node-1.crt",
key_path = "/etc/icinga2/ca/icinga-node-1.key",
bind_port = 8888,
peers = [ "icinga-node-2" ]
}
Attributes:
Name |Description
----------------|----------------
cert\_path |TODO
key\_path |TODO
ca\_path |TODO
bind\_host |TODO
bind\_port |TODO
peers |TODO
cert\_path |**Required.** Path to the public key.
key\_path |**Required.** Path to the private key.
ca\_path |**Required.** Path to the CA certificate file.
bind\_host |**Optional.** The IP address the cluster listener should be bound to.
bind\_port |**Optional.** The port the cluster listener should be bound to.
peers |**Optional.** A list of
### <a id="objecttype-endpoint"></a> Endpoint

View File

@ -169,7 +169,9 @@ A sample config part can look like this:
ca_path = "/etc/icinga2/ca/ca.crt",
cert_path = "/etc/icinga2/ca/icinga-node-1.crt",
key_path = "/etc/icinga2/ca/icinga-node-1.key",
bind_port = 8888,
peers = [ "icinga-node-2" ]
}