DESCRIPTION
The nsca component manages the NSCA daemon and the NSCA client configuration. The NSCA client (sender) is used to submit check results that are obtained on a node to the Nagios server. In Nagios terms, they are known as passive check results (i.e. not initated by Nagios).
COMPONENT STRUCTURE
This component can be used to configure an NSCA daemon and/or NSCA client.
The daemon is only configured if its configuration exists under /software/components/nsca/daemon
,
the client part is configured if the configuration under /software/components/nsca/send
is defined.
NSCA DAEMON
All fields are mandatory, unless it is explicitly stated:
-
/ software/components/nsca/daemon/pid_file
: stringThe name of the file in which the NSCA daemon should write its process ID number. Defaults to
/var/run/nsca.pid
. -
/ software/components/nsca/daemon/server_port
: longPort number on which the daemon should listen for connections.
-
/ software/components/nsca/daemon/server_address
: stringAddress that NSCA has to bind to in case there is more as one interface. This field is optional.
-
/ software/components/nsca/daemon/user
: stringThis determines the effective user that the NSCA daemon should run as. Defaults to "nagios".
-
/ software/components/nsca/daemon/group
: stringThis determines the effective group that the NSCA daemon should run as. Defaults to "nagios".
-
/ software/components/nsca/daemon/chroot
: stringThis determines a directory into which the nsca daemon will perform a chroot(2) operation before dropping its privileges. This field is optional.
-
/ software/components/nsca/daemon/debug
: booleanThis option determines whether or not debugging messages are logged to the syslog facility. Defaults to false.
-
/ software/components/nsca/daemon/command_file
: stringThis is the location of the Nagios command file that the daemon should write all service check results that it receives. Defaults to
/var/log/nagios/rw/nagios.cmd
. -
/ software/components/nsca/daemoni/alt_dump_file
: stringThis is used to specify an alternate file the daemon should write service check results to in the event the command file does not exist. Defaults to
/var/log/nagios/rw/nsca.dump
. -
/ software/components/nsca/daemon/aggregate_writes
: booleanThis option determines whether or not the nsca daemon will aggregate writes to the external command file for client connections that contain multiple check results. Defaults to false.
-
/ software/components/nsca/daemon/append_to_file
: booleanThis option determines whether or not the nsca daemon will open the external command file for writing or appending. Defaults to false.
-
/ software/components/nsca/daemon/max_packet_age
: longThis option is used by the nsca daemon to determine when client data is too old to be valid. Defaults to 30.
-
/ software/components/nsca/daemon/password
: stringThis is the password/passphrase that should be used to decrypt the incoming packets.
-
/ software/components/nsca/daemon/decryption_method
: booleanThis option determines the method by which the nsca daemon will decrypt the packets it receives from the clients. Defaults to 1.
NSCA CLIENT
-
/ software/components/nsca/send/password
: stringThis is the password/passphrase that should be used to encrypt the outgoing packets.
-
/ software/components/nsca/send/encryption_method
: longThis option determines the method by which the send_nsca client will encrypt the packets it sends to the nsca daemon. Defaults to 1.