Skip to main content
Version: ⭐ 24.10

Commands

Definition​

A command is the definition of a command line that uses a script or an application to perform an action. It is possible to execute this command by specifying arguments.

There are four types of command:

  • Verification commands are used by the schedulers to verify the status of a host or service.
  • Notification commands are used by the schedulers to alert the contacts (via mail, SMS, etc.).
  • Discovery commands are used by the schedulers to discover.
  • Miscellaneous commands are used by the additional modules (to perform certain actions), by the scheduler for data processing, etc.

All the commands can be configured in the following menu: Configuration > Commands.

image

By default, locked commands are hidden. Check the "Locked elements" box to list all commands.

Adding a command​

  1. Go to the Configuration > Commands menu
  2. Click Add

image

The configuration fields of a command are the same regardless of the type of command chosen.

Configuration fields​

  • The Command Name field defines the name of the command.
  • The Command Type field allows us to choose the type of command.
  • The Command Line field indicates the application or script used with the command.
  • The Enable shell box allows us to enable functions that are specific to a shell, such as the pipe, etc.
  • The Argument Example field defines examples of arguments (each argument starts with a ”!”)
  • The Describe arguments button is used to add a description to “$ARGn$”-type arguments. This description will be visible when using the command in a host or service form.
  • The Clear arguments button deletes the description of arguments defined
  • The Describe macros button is used to add a description to all macros. This description will be visible when using the command in a host or service form.
  • The Connectors selectlist is used to link a Connector to the command. For more information on Connectors, refer to the chapters entitled Perl Connector and SSH Connector.
  • The Graph template field is used to link the command to a graph template.
  • The Comment field can be used to make a comment on the command.

Arguments and macros​

In the Command Line field, it is possible to use macros and arguments.

The macros are used to pass various settings to the scripts called up by the commands. During execution of the command by the scheduler, all of the arguments and macros are replaced by their respective values. Each macro appears in the form $value$:

$CENTREONPLUGINS$/centreon_linux_snmp.pl --plugin=os::linux::snmp::plugin --mode=cpu \
--hostname=$HOSTADDRESS$ --snmp-version='$_HOSTSNMPVERSION$' \
--snmp-community='$_HOSTSNMPCOMMUNITY$' $_HOSTSNMPEXTRAOPTIONS$ \
--warning-average='$_SERVICEWARNING$' \
--critical-average='$_SERVICECRITICAL$' $_SERVICEEXTRAOPTIONS$

Good practice requires replacing the arguments by custom macros.

Connectors​

SSH connector​

Centreon SSH Connector is free software from Centreon available under the Apache Software License version 2 (ASL 2.0). It speeds up execution checks over SSH when used with Centreon Engine.

Installation​

Centreon recommends using its official packages. Most of Centreon’s endorsed software is available as RPM packages.

Run the following commands as a privileged user:

dnf install centreon-connector-ssh

Perl connector​

Centreon Perl Connector is free software from Centreon available under the Apache Software License version 2 (ASL 2.0). It speeds up execution of Perl scripts when used with Centreon Engine.

Installation​

Centreon recommends using its official packages. Most of Centreon’ endorsed software are available as RPM packages.

Run the following commands as a privileged user:

dnf install centreon-connector-perl