Difference between revisions of "Checkmk"

From Hornbill
Jump to navigation Jump to search
Line 1: Line 1:
 
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > checkmk |[[:Category:ITOM|Index]]}}
 
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > checkmk |[[:Category:ITOM|Index]]}}
 
[[File:checkmk_logo.png|x170px]]
 
[[File:checkmk_logo.png|x170px]]
−
{{IntroAndLinks|## Why use this
+
{{IntroAndLinks|A collection of operations to enable the automation of management of checkmk alerts, users and hosts from Hornbill workflows.
−
**You can create Users, Host Servers, Contact Groups, Suppress System and Service Notifications and Activate Pending Changes within checkmk from your Hornbill instance. **
 
−
 
 
−
**Example**: You need to monitor your servers, applications, networks, cloud infrastructures (public, private, hybrid), containers, storage, databases or environment sensors. You can simply make calls from within Hornbill's system or create and set up remote hosts to test how smoothly they run.
 
−
 
 
−
## What it does
 
−
* Activate Pending Changes: When ever you Create, Update or Delete anything within checkmk this function will activate those changes in the system.
 
−
* Add Or Remove User To Contact Grops: Hosts and Services have contact groups that are alerted to changes or errors to that specific instance.
 
−
* Add Roles To A checkmk User: Roles determine what each user has access to within your instance of checkmk.
 
−
* Create A checkmk Host: Creates a Host server within checkmk.
 
−
* Create A checkmk User: Creates a User within checkmk.
 
−
* Delete A checkmk Host: Deletes a Host from checkmk.
 
−
* Delete A checkmk User: Deletes a User from checkmk.
 
−
* Delete A checkmk Contact Group: Deletes a Contact Group from your instance of checkmk.
 
−
* Delete Downtime: Removes a period of Downtime from your Host or Service within checkmk.
 
−
* Get User: Get User details from a specific checkmk user.
 
−
* Suppress Alert: Create a period of downtime against a Host to mute notifications.
 
−
* Suppress Service Alert: Create a period of downtime against a Service to mute notifications.
 
−
* Update A checkmk Host: Updates a Host server within checkmk.
 
−
* Update A checkmk User: Updates a User within checkmk.
 
−
 
 
−
## Benefits
 
−
* Control checkmk from the service desk, business process workflows, or runbooks.
 
−
* Increase visibilty of Server and Service issues and managment.
 
−
 
 
−
## How to get it
 
−
* You can try out ITOM for free (not for production use, limited runs) by installing the ITOM application from the Hornbill App Store.
 
−
* If you would like to explore ITOM and consider subscribing, please contact your account manager [here](https://www.hornbill.com/contact-us).
 
−
 
 
−
## Requirements
 
−
* Install the Hornbill Site Integration Server inside your firewall (if you don't already have it)
 
−
* If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. See the following website for [more information](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6)
 
−
 
 
−
## See also
 
−
* Hyper-V Automation
 
−
 
 
|
 
|
 
<!-- Related Links go here -->
 
<!-- Related Links go here -->
Line 61: Line 26:
 
To configure your '''Target Machine''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':  
 
To configure your '''Target Machine''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':  
  
−
* In the Admin console, navigate to: System > Security > KeySafe;
+
* In the Admin console, navigate to System > Security > KeySafe;
 
* Click on + then select <code>Username + Password</code>;
 
* Click on + then select <code>Username + Password</code>;
 
* Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
 
* Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
Line 80: Line 45:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Suppresses Alerts from the checkmk instance.
 
Suppresses Alerts from the checkmk instance.
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 99: Line 74:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Implements a downtime for a service on CheckMK to temporarily stop notifications
 
Implements a downtime for a service on CheckMK to temporarily stop notifications
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 119: Line 104:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
This api call will remove all downtimes for the specified host, service or both if both are provided.
 
This api call will remove all downtimes for the specified host, service or both if both are provided.
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 136: Line 131:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Create a new User for your CheckMK site
 
Create a new User for your CheckMK site
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 159: Line 164:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Updates the specified Check MK User
 
Updates the specified Check MK User
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 186: Line 201:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
This function will remove a Check MK user from your site
 
This function will remove a Check MK user from your site
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 202: Line 227:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Get User details from CheckMK
 
Get User details from CheckMK
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 224: Line 259:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
This function allows you to create a contact group, in order to add contacts to the group update them using the update user or add to contact group operations
 
This function allows you to create a contact group, in order to add contacts to the group update them using the update user or add to contact group operations
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 246: Line 291:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
This function allows you to delete a contact group from your site.
 
This function allows you to delete a contact group from your site.
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 262: Line 317:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Activate changes to site
 
Activate changes to site
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 283: Line 348:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Create a new CheckMK Host
 
Create a new CheckMK Host
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 302: Line 377:
 
*********
 
*********
 
NOTE: if you receive a 409 error please run the activate changes function and then re run the name update.
 
NOTE: if you receive a 409 error please run the activate changes function and then re run the name update.
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 318: Line 403:
 
===Delete A CheckMK Host===
 
===Delete A CheckMK Host===
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
Use the Host name to remove the host from the Site
+
Use the Hostname to remove the host from the Site
 +
 
 +
=====Extra Credentials=====
 +
 
 +
This operation requires an extra credential to be provided:
 +
 
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 335: Line 430:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Please add the roles you would like this user to have separated by a comma like so: admin, user, guest
 
Please add the roles you would like this user to have separated by a comma like so: admin, user, guest
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 352: Line 457:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Please add the roles you would like this user to have separated by a comma. For Example: admin, user, guest
 
Please add the roles you would like this user to have separated by a comma. For Example: admin, user, guest
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 369: Line 484:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Please add the group conversations you would like this user to have separated by a comma like so: chat1, chat2, chat3
 
Please add the group conversations you would like this user to have separated by a comma like so: chat1, chat2, chat3
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====
Line 389: Line 514:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 
Please add the group conversations you would like this user to be added to separated by a comma like so: chat1, chat2, chat3
 
Please add the group conversations you would like this user to be added to separated by a comma like so: chat1, chat2, chat3
 +
 +
=====Extra Credentials=====
 +
 +
This operation requires an extra credential to be provided:
 +
 +
* Credential Reference: <code>credential1</code>
 +
* Credential Keysafe Key Type: <code>Username + Password</code>
 +
:* Username: Your checkmk username
 +
:* Password: Your checkmk password
 +
:* API Endpoint: The API endpoint for your checkmk instance, for example: https://your.checkmk.server/your_checkmk_site/checkmk/api/
  
 
====Input Parameters====
 
====Input Parameters====

Revision as of 11:19, 11 November 2022

Home > Administration > IT Operations Management > ITOM Package Library > checkmk Index

Checkmk logo.png

Introduction

A collection of operations to enable the automation of management of checkmk alerts, users and hosts from Hornbill workflows.

Related Articles

Target Environment Requirements

Credentials

Accounts used when executing jobs against operations contained within this package must adhere to the following requirements:

  • The target machine must have a local admin user that will be used for running the operations;
  • Remote Login must be enabled for the user above user (System Preferences > Sharing > Remote Login);
  • Configuration for the user must be added to the sudoers file on the target machine, to allow the above user to sudo without a password (example: someadminuser ALL = (ALL) NOPASSWD:ALL).

KeySafe Configuration

Checkmk keysafe.png

When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges on the target.

To configure your Target Machine account authentication in KeySafe:

  • In the Admin console, navigate to System > Security > KeySafe;
  • Click on + then select Username + Password;
  • Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
  • Optionally add a description;
  • Populate the Username field with the domain/local account username for the account being used on the target machine;
  • Populate the Password field with the password for the above account;
  • Select Create Key to save.

Once you have created your KeySafe Key, you can then use it when creating IT Automation Jobs from this package. See screenshots to the right for examples.

Package Operations

The checkmk package contains the following operations, than can be used to create ITOM Jobs directly, or included in your Business Processes and/or IT Operations Management Rubooks.


Suppress Host Alerts

Suppresses Alerts from the checkmk instance.

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -
  • StartTime MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZ
  • EndTime MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZ
  • Comment -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Suppress Service Notifications

Implements a downtime for a service on CheckMK to temporarily stop notifications

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -
  • StartTime MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZ
  • EndTime MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZ
  • ServiceDescriptions MANDATORY - The service description
  • Comment -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Delete Downtimes

This api call will remove all downtimes for the specified host, service or both if both are provided.

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -
  • ServiceDescriptions -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Create A New CheckMK User

Create a new User for your CheckMK site

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • NewUser MANDATORY -
  • FullName -
  • UserPassword -
  • DisableLogin -
  • EmailAddress -
  • Roles -
  • ContactGroup -
  • DisableNotifications -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Update A Existing CheckMK User

Updates the specified Check MK User

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -
  • UserPassword -
  • FullName -
  • DisableLogin MANDATORY -
  • EmailAddress -
  • DisableNotifications MANDATORY -

Output Parameters

  • id
  • fullName
  • disableLogin
  • email
  • roles
  • contactGroups
  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Delete A CheckMK User

This function will remove a Check MK user from your site

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Get User Information

Get User details from CheckMK

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -

Output Parameters

  • id
  • fullName
  • disableLogin
  • email
  • roles
  • contactGroups
  • outcome The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Create A CheckMK Contact Group

This function allows you to create a contact group, in order to add contacts to the group update them using the update user or add to contact group operations

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Name MANDATORY - Please do not use any blank spaces
  • Alias MANDATORY -

Output Parameters

  • id
  • contactGroupConfig
  • title
  • member
  • alias
  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Delete A CheckMK Contact Group

This function allows you to delete a contact group from your site.

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Name MANDATORY - Please do not use any blank spaces

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Activate Site Changes

Activate changes to site

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Redirect MANDATORY -
  • Sites -
  • Force_Foreign_Changes MANDATORY -

Output Parameters

  • domainType
  • id
  • title
  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Create A CheckMK Host

Create a new CheckMK Host

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -
  • ipAddress MANDATORY -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Update A CheckMK Host Name

Re names the selected Host's Host Name,

NOTE: if you receive a 409 error please run the activate changes function and then re run the name update.

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -
  • NewHostName MANDATORY -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Delete A CheckMK Host

Use the Hostname to remove the host from the Site

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • Hostname MANDATORY -

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Add Roles To A CheckMK User

Please add the roles you would like this user to have separated by a comma like so: admin, user, guest

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -
  • Roles MANDATORY - Separate each value with a comma

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Remove Roles From A CheckMK User

Please add the roles you would like this user to have separated by a comma. For Example: admin, user, guest

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -
  • Roles MANDATORY - Separate each value with a comma

Output Parameters

  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Remove A CheckMK User From A Contact Group

Please add the group conversations you would like this user to have separated by a comma like so: chat1, chat2, chat3

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -
  • ContactGroup MANDATORY - Separate each value with a comma

Output Parameters

  • id
  • fullName
  • roles
  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation

Add A CheckMK User To A Contact Group

Please add the group conversations you would like this user to be added to separated by a comma like so: chat1, chat2, chat3

Extra Credentials

This operation requires an extra credential to be provided:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

  • User MANDATORY -
  • ContactGroup MANDATORY - Separate each value with a comma

Output Parameters

  • id
  • fullName
  • contactGroups
  • outcome MANDATORY The outcome of the operation (OK/FAIL)
  • errors Any errors returned by the operation
Retrieved from "https://wiki.hornbill.com/index.php?title=Checkmk&oldid=30333"