About the connector
Centreon is a free Open Source monitoring software that provides many features such as consultation of services state of monitored equipment, metrology, reporting, access to monitoring events, and advanced management of users using access control lists. Centreon provides a simplified interface to make the system status view accessible to a broader range of users, including non-technical users. However, technicians always have access to the technical information of the scheduler.
This document provides information about the Centreon connector, which facilitates automated interactions with the Centreon server using FortiSOAR™ playbooks. Add the Centreon connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving monitoring information for hosts and services, and adding or deleting hosts from the Centreon server.
Version information
Connector Version: 1.0.0
FortiSOAR™ Version Tested on: 4.11.0-1161
Centreon Version Tested on: 3.4.6
Authored By: Fortinet.
Certified: Yes
Installing the connector
All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:
yum install cyops-connector-centreon
For the detailed procedure to install a connector, click here.
Prerequisites to configuring the connector
- You must have the URL of the Centreon server setup to which you will connect and perform the automated operations and credentials (username-password pair) to access that server.
- To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.
Configuring the connector
For the procedure to configure a connector, click here.
Configuration parameters
In FortiSOAR™, on the Connectors page, click the Centreon connector row, and in the Configuration tab enter the required configuration details.
| Parameter |
Description |
| Server URL |
URL of the Centreon server setup to which you will connect and perform the automated operations. |
| Username |
Username configured for your account to access the Centreon server to which you will connect and perform the automated operations. |
| Password |
Password configured for your account to access the Centreon server to which you will connect and perform the automated operations. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True. |
Actions supported by the connector
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
| Function |
Description |
Annotation and Category |
| Get Hosts Status |
Retrieves monitoring information regarding the status of all hosts or specified hosts, based on the input parameters you have specified, from Centreon. |
get_host_status
Investigation |
| Get Service Status |
Retrieves monitoring information regarding services of all hosts or specified hosts, based on the input parameters you have specified, from Centreon. |
get_service_status
Investigation |
| Get Hosts |
Retrieves a list and details of all available hosts from the Centreon. |
get_hosts
Investigation |
| Add Host |
Adds a new host to Centreon for monitoring, based on input parameters you have specified. |
add_host
Investigation |
| Remove Host |
Removes an existing host from Centreon for monitoring, based on hostname you have specified. |
delete_host
Investigation |
| Get Macro |
Retrieves all macros that are associated with the hostname you have specified from Centreon. |
get_macro
Investigation |
| Set Macro |
Sets an updated macro value for an existing macro on Centreon. If the macro does not exist, then a new macro with the specified value is created on Centreon. |
set_macro
Investigation |
| Delete Macro |
Deletes the specified macro associated with the specified host on Centreon. |
delete_macro
Investigation |
| Get Templates |
Retrieves all templates that are associated with the hostname you have specified from Centreon. |
get_templates
Investigation |
| Set Template |
Sets the specified template for a specified host on Centreon. If the specified template already exists on the specified host, then the configuration of the previous template gets overridden. |
set_template
Investigation |
| Add Template |
Adds a new template to a specified host on Centreon, without overriding any previous configurations, i.e., the new template is added as the host template, without removing the template that is already linked to that hostname. |
add_template
Investigation |
| Delete Template |
Deletes a specified template associated with the specified host on Centreon. |
delete_template
Investigation |
| Get Contacts |
Retrieves all users (contacts) that are associated with the hostname you have specified from Centreon. |
get_contacts
Investigation |
| Add Contact |
Adds a new contact to a specified host on Centreon, without overriding any previous configurations. |
add_contact
Investigation |
| Set Contact |
Links the specified user to a specified host on Centreon. If the specified contact already exists on the specified host, then the previous contact gets overridden. |
set_contact
Investigation |
| Delete Contact |
Deletes the specified contact associated with the specified host on Centreon. |
delete_contact
Investigation |
| Get Parent |
Retrieves all parents that are linked with the hostname you have specified from Centreon. |
get_parent
Investigation |
| Add Parent |
Adds a new parent in the specified host's parent's list on Centreon, without overriding any previous configurations. |
add_parent
Investigation |
| Set Parent |
Links the specified parent to a specified host on Centreon. If the specified parent already exists on the specified host, then the configuration of the previous parent gets overridden. |
set_parent
Investigation |
| Delete Parent |
Deletes the specified parent from the parent's list of the specified host on Centreon. |
delete_parent
Investigation |
| Get Host Groups |
Retrieves all host groups for the hostname you have specified from Centreon. |
get_host_group
Investigation |
| Add Host Group |
Adds a new host group to the specified host in Centreon, without overriding any previous configurations. |
add_host_group
Investigation |
| Set Host Group |
Sets the specified host group to a specified host on Centreon. If the specified host group already exists on the specified host, then the configuration of the previous host group gets overridden. |
set_host_group
Investigation |
| Delete Host Group |
Deletes the specified host group from the specified host on Centreon. |
delete_host_group
Investigation |
| Enable Host |
Enables the specified host on Centreon, based on hostname you have specified. |
enable_host
Investigation |
| Disable Host |
Disables the specified host from Centreon, based on hostname you have specified. |
disable_host
Investigation |
operation: Get Hosts Status
Input parameters
Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list, containing status information for all hosts, is returned.
| Parameter |
Description |
| Sort Type |
Sorts the host monitoring information that is retrieved from Centreon based on this option. You can choose from the following options: Ascending or Descending.
By default, this is set to Ascending. |
| View Type |
Type of host for which you want to retrieve monitoring information, regarding status, from Centreon. You can choose from the following options: All, Unhandled, or Problems.
By default, this is set to All. |
| Limit |
Maximum number of lines that this operation should return. |
Output
The JSON output contains details of the monitoring status information regarding the status of all hosts or specified hosts (based on the input parameters you have specified) retrieved from Centreon.
Following image displays a sample output:
operation: Get Service Status
Input parameters
Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list, containing service information for all hosts, is returned.
| Parameter |
Description |
| Sort Type |
Sorts the host monitoring information that is retrieved from Centreon based on this option. You can choose from the following options: Ascending or Descending.
By default, this is set to Ascending. |
| View Type |
Type of host for which you want to retrieve monitoring information, regarding services, from Centreon. You can choose from the following options: All, Unhandled, or Problems.
By default, this is set to All. |
| Limit |
Maximum number of lines that this operation should return. |
Output
The JSON output contains details of the monitoring status information regarding services of all hosts or specified hosts (based on the input parameters you have specified) retrieved from Centreon.
Following image displays a sample output:
operation: Get Hosts Status
Input parameters
None.
Output
The JSON output contains a list and details of all available hosts retrieved from Centreon.
Following image displays a sample output:
operation: Add Host
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host that you want to add to Centreon for monitoring. |
| Host Alias Name |
Alias name that is used to identify the host that you want to add to Centreon for monitoring.
|
| Host IP Address |
IP address of the host that you want to add to Centreon for monitoring. |
| Poller |
(Optional) Poller that will monitor the host that you want to add in Centreon. |
| Template |
(Optional) Host template for the host that you want to add in Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully add the host to Centreon for monitoring.
Following image displays a sample output:
operation: Delete Host
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host that you want to remove from Centreon for monitoring. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully remove the host to Centreon for monitoring.
Following image displays a sample output:
operation: Get Macro
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated macros you want to retrieve from Centreon. |
Output
The JSON output contains a list and details of all macros that are associated with the specified host retrieved from Centreon.
Following image displays a sample output:
operation: Set Macro
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated macro value you want to update on Centreon. |
| Macro Name |
Name of the macro whose value you want to update on Centreon.
Note: If the macro does not exist on Centreon, then a new macro with the specified name and value is created on Centreon. |
| New Macro Value |
New value of an existing macro that you want to update on Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully update the value of the specified macro on Centreon.
Following image displays a sample output:
operation: Delete Macro
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host from which you want to delete the specified macro on Centreon. |
| Macro Name |
Name of the macro that you want to delete from the specified host on Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully delete the specified macro from the specified host on Centreon.
Following image displays a sample output:
operation: Get Templates
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated templates you want to retrieve from Centreon. |
Output
The JSON output contains a list and details of all templates that are associated with the specified host retrieved from Centreon.
Following image displays a sample output:
operation: Set Template
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to set the specified template. |
| Template Name |
Name of the template that you want to set on the specified hostname on Centreon. The template that you specify must exist in host templates.
Note: If the template already exists, then its configuration gets overridden by the current template's configuration. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully set the template for the specified host on Centreon.
Following image displays a sample output:
operation: Add Template
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to add the specified template. |
| Template Name |
Name of the template that you want to add to the specified hostname on Centreon. The template that you specify must exist in host templates.
Note: The new template is added as the host template, without removing the template that is already linked to that hostname. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully add the template to the specified host on Centreon.
Following image displays a sample output:
operation: Delete Template
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon from which you want to delete the specified template. |
| Template Name |
Name of the template that you want to delete from the specified hostname on Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully delete the template from the specified host on Centreon.
Following image displays a sample output:
operation: Get Contacts
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated users (contacts) you want to retrieve from Centreon. |
Output
The JSON output contains a list and details of all users (contacts) that are associated with the specified host retrieved from Centreon.
Following image displays a sample output:
operation: Add Contact
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to add the specified contact. |
| Contact Name |
Name of the contact that you want to add to the specified hostname on Centreon.
Note: The new contact is added to the specified hostname, without overriding any previous configurations. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully add the contact to the specified host on Centreon.
Following image displays a sample output:
operation: Set Contact
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to set the specified contact. |
| Contact Names |
Name of the contact that you want to set on the specified hostname on Centreon. The contact name that you specify must exist. To enter multiple contact names use |. For example, admin|superadmin.
Note: If the contact already exists, then its configuration gets overridden by the current contact's configuration. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully set the template for the specified host on Centreon.
Following image displays a sample output:
operation: Delete Contact
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host from which you want to delete the specified contact on Centreon. |
| Contact Names |
Name of the contact that you want to delete from the specified host on Centreon. To delete multiple contacts, use |. For example, admin|superadmin. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully delete the specified contact from the specified host on Centreon.
Following image displays a sample output:
operation: Get Parent
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated users (contacts) you want to retrieve from Centreon. |
Output
The JSON output contains a list and details of all parents that are linked with the specified host retrieved from Centreon.
Following image displays a sample output:
operation: Add Parent
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to add the specified parent to its parent list. |
| Parent Name |
Name of the parent that you want to add to the specified hostname on Centreon. The parent name that you specify must exist. To enter multiple parent names use |. For example, admin|superadmin.
Note: The new parent is added to the specified hostname, without overriding any previous configurations. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully add the parent to the specified host's list of parents on Centreon.
Following image displays a sample output:
operation: Set Parent
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to set the specified parent. |
| Contact Name |
Name of the parent that you want to set on the specified hostname on Centreon. The parent name that you specify must exist. To enter multiple contact names use |. For example, admin|superadmin.
Note: If the parent already exists, then its configuration gets overridden by the current parent's configuration. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully set the parent for the specified host on Centreon.
Following image displays a sample output:
operation: Delete Parent
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host from which you want to delete the specified parent on Centreon. |
| Parent Name |
Name of the parent that you want to delete from the parent's list in the specified host on Centreon. To delete multiple parents, use |. For example, admin|superadmin. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully delete the specified parent from the specified host on Centreon.
Following image displays a sample output:
operation: Get Host Groups
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host whose associated host groups you want to retrieve from Centreon. |
Output
The JSON output contains a list and details of all host groups that are associated with the specified host retrieved from Centreon.
Following image displays a sample output:
operation: Add Host Group
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon to which you want to add the specified host group. |
| Host Group Name |
Name of the host group that you want to add to the specified host on Centreon. The host group name that you specify must exist. To enter multiple host groups use |.
Note: The new host group is added to the specified hostname, without overriding any previous configurations. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully add the host group to the specified host on Centreon.
Following image displays a sample output:
operation: Set Host Group
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host on Centreon for which you want to set the specified host group. |
| Host Group Name |
Name of the host group that you want to set on the specified hostname on Centreon. The host group name that you specify must exist. To enter multiple host groups use |.
Note: If the host group already exists, then its configuration gets overridden by the current parent's configuration. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully set the host group for the specified host on Centreon.
Following image displays a sample output:
operation: Delete Host group
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host from which you want to delete the specified host group on Centreon. |
| Host Group Name |
Name of the host group that you want to delete from the specified host on Centreon. To delete multiple host groups, use |. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully delete the specified host group from the specified host on Centreon.
Following image displays a sample output:
operation: Enable Host
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host that you want to enable on Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully enable the specified host on Centreon.
Following image displays a sample output:
operation: Disable Host
Input parameters
| Parameter |
Description |
| Host Name |
Name of the host that you want to disable on Centreon. |
Output
The JSON output returns the status of the operation from Centreon, such as status: Success message, if you could successfully disable the specified host on Centreon.
Following image displays a sample output:
Included playbooks
The Sample - Centreon - 1.0.0 playbook collection comes bundled with the Centreon connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Centreon connector.
- Contact : Add Contact
- Contact : Delete Contact
- Contact : Get Contacts
- Contact : Set Contact
- Host : Add Host
- Host : Delete Host
- Host : Disable Host
- Host : Enable Host
- Host : Get Hosts
- Host : Get Hosts Status
- Host Group : Add Host Group
- Host Group : Delete Host Group
- Host Group : Get Host Groups
- Host Group : Set Host Group
- Macro : Delete Macro
- Macro : Get Macro
- Macro : Set Macro
- Parent : Add Parent
- Parent : Delete Parent
- Parent : Get Parents
- Parent : Set Parent
- Service : Get Service Status
- Template : Add Template
- Template : Delete Template
- Template : Get Templates
- Template : Set Template
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
