From 95020ec24a86758771826cac536a31983c477ea6 Mon Sep 17 00:00:00 2001 From: loiclau Date: Mon, 27 Nov 2017 15:02:09 +0100 Subject: [PATCH] fix(doc) doc for host get param #5783 --- doc/en/api/clapi/objects/hosts.rst | 106 ++++++++++++++++++++++++++++ doc/fr/api/clapi/objects/hosts.rst | 107 +++++++++++++++++++++++++++++ 2 files changed, 213 insertions(+) diff --git a/doc/en/api/clapi/objects/hosts.rst b/doc/en/api/clapi/objects/hosts.rst index 7b6097559dc..813dba42987 100644 --- a/doc/en/api/clapi/objects/hosts.rst +++ b/doc/en/api/clapi/objects/hosts.rst @@ -196,6 +196,112 @@ timezone Timezone .. note:: You need to generate your configuration file and restart monitoring engine in order to apply changes. +Getparam +-------- + +In order to get specific parameters on a host configuration, use the **GETPARAM** action:: + + [root@centreon ~]# ./centreon -u admin -p centreon -o HOST -a getparam -v "test;alias" + test + [root@centreon ~]# ./centreon -u admin -p centreon -o HOST -a setparam -v "test;timezone" + Europe/Berlin + +You may edit the following parameters: + +==================================== ================================================================================= +Parameter Description +==================================== ================================================================================= +2d_coords 2D coordinates (used by statusmap) + +3d_coords 3D coordinates (used by statusmap) + +action_url Action URL + +activate Whether or not host is enabled + +active_checks_enabled Whether or not active checks are enabled + +address Host IP Address + +alias Alias + +check_command Check command + +check_command_arguments Check command arguments + +check_interval Normal check interval + +check_freshness Enables check freshness + +check_period Check period + +contact_additive_inheritance Enables contact additive inheritance + +cg_additive_inheritance Enables contactgroup additive inheritance + +event_handler Event handler command + +event_handler_arguments Event handler command arguments + +event_handler_enabled Whether or not event handler is enabled + +first_notification_delay First notification delay (in seconds) + +flap_detection_enabled Whether or not flap detection is enabled + +flap_detection_options Flap detection options 'o' for Up, 'd' for Down, 'u' for Unreachable + +host_high_flap_threshold High flap threshold + +host_low_flap_threshold Low flap threshold + +icon_image Icon image + +icon_image_alt Icon image text + +max_check_attempts Maximum number of attempt before a HARD state is declared + +name Host name + +notes Notes + +notes_url Notes URL + +notifications_enabled Whether or not notification is enabled + +notification_interval Notification interval + +notification_options Notification options + +notification_period Notification period + +recovery_notification_delay Recovery notification delay + +obsess_over_host Whether or not obsess over host option is enabled + +passive_checks_enabled Whether or not passive checks are enabled + +process_perf_data Process performance data command + +retain_nonstatus_information Whether or not there is non-status retention + +retain_status_information Whether or not there is status retention + +retry_check_interval Retry check interval + +snmp_community Snmp Community + +snmp_version Snmp version + +stalking_options Comma separated options: 'o' for OK, 'd' for Down, 'u' for Unreachable + +statusmap_image Status map image (used by statusmap + +host_notification_options Notification options (d,u,r,f,s) + +timezone Timezone +==================================== ================================================================================= + Setinstance ----------- diff --git a/doc/fr/api/clapi/objects/hosts.rst b/doc/fr/api/clapi/objects/hosts.rst index 685165ddbd7..673cfa1b0e9 100644 --- a/doc/fr/api/clapi/objects/hosts.rst +++ b/doc/fr/api/clapi/objects/hosts.rst @@ -193,6 +193,113 @@ timezone Timezone ==================================== ================================================================================= +Getparam +-------- + +In order to get specific parameters on a host configuration, use the **GETPARAM** action:: + + [root@centreon ~]# ./centreon -u admin -p centreon -o HOST -a getparam -v "test;alias" + test + [root@centreon ~]# ./centreon -u admin -p centreon -o HOST -a setparam -v "test;timezone" + Europe/Berlin + +You may edit the following parameters: + +==================================== ================================================================================= +Parameter Description +==================================== ================================================================================= +2d_coords 2D coordinates (used by statusmap) + +3d_coords 3D coordinates (used by statusmap) + +action_url Action URL + +activate Whether or not host is enabled + +active_checks_enabled Whether or not active checks are enabled + +address Host IP Address + +alias Alias + +check_command Check command + +check_command_arguments Check command arguments + +check_interval Normal check interval + +check_freshness Enables check freshness + +check_period Check period + +contact_additive_inheritance Enables contact additive inheritance + +cg_additive_inheritance Enables contactgroup additive inheritance + +event_handler Event handler command + +event_handler_arguments Event handler command arguments + +event_handler_enabled Whether or not event handler is enabled + +first_notification_delay First notification delay (in seconds) + +flap_detection_enabled Whether or not flap detection is enabled + +flap_detection_options Flap detection options 'o' for Up, 'd' for Down, 'u' for Unreachable + +host_high_flap_threshold High flap threshold + +host_low_flap_threshold Low flap threshold + +icon_image Icon image + +icon_image_alt Icon image text + +max_check_attempts Maximum number of attempt before a HARD state is declared + +name Host name + +notes Notes + +notes_url Notes URL + +notifications_enabled Whether or not notification is enabled + +notification_interval Notification interval + +notification_options Notification options + +notification_period Notification period + +recovery_notification_delay Recovery notification delay + +obsess_over_host Whether or not obsess over host option is enabled + +passive_checks_enabled Whether or not passive checks are enabled + +process_perf_data Process performance data command + +retain_nonstatus_information Whether or not there is non-status retention + +retain_status_information Whether or not there is status retention + +retry_check_interval Retry check interval + +snmp_community Snmp Community + +snmp_version Snmp version + +stalking_options Comma separated options: 'o' for OK, 'd' for Down, 'u' for Unreachable + +statusmap_image Status map image (used by statusmap + +host_notification_options Notification options (d,u,r,f,s) + +timezone Timezone +==================================== ================================================================================= + + .. note:: You need to generate your configuration file and restart monitoring engine in order to apply changes.