Checkmk: Difference between revisions
JoshHowitt (talk | contribs) No edit summary |
JoshHowitt (talk | contribs) No edit summary |
||
Line 43: | Line 43: | ||
:* [[Hornbill_KeySafe|KeySafe]] | :* [[Hornbill_KeySafe|KeySafe]] | ||
}} | }} | ||
| | |||
==Target Environment Requirements== | ==Target Environment Requirements== | ||
Revision as of 11:05, 11 November 2022
Home > Administration > IT Operations Management > ITOM Package Library > checkmk | Index |
Introduction |
{{{2}}} |
|
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
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.
Input Parameters
Hostname
MANDATORY -StartTime
MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZEndTime
MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZComment
-
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
Input Parameters
Hostname
MANDATORY -StartTime
MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZEndTime
MANDATORY - Format: YYYY-MM-DDTHH:MM:SSZServiceDescriptions
MANDATORY - The service descriptionComment
-
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.
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
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
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
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
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
Input Parameters
Name
MANDATORY - Please do not use any blank spacesAlias
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.
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
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
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.
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 Host name to remove the host from the Site
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
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
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
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
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