|
|
| (6 intermediate revisions by 2 users not shown) |
| 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]]}}
| + | This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. |
| − | [[File:macos_logo.png|300px]]
| |
| − | {{IntroAndLinks|## Why use this
| |
| − | **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.
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | | + | [[Category:HDOC]] |
| − | ## 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 -->
| |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| − | | |
| − | ==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==
| |
| − | [[File:itomtarget_keysafe.png|300px|right]]
| |
| − | | |
| − | 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 '''[[Hornbill_KeySafe|KeySafe]]''':
| |
| − | | |
| − | * In the Admin console, navigate to: System > Security > KeySafe;
| |
| − | * 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);
| |
| − | * 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_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks.
| |
| − | | |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Suppress Host Alerts===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Suppresses Alerts from the checkmk instance.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | * <code>StartTime</code> '''MANDATORY''' - Format: YYYY-MM-DDTHH:MM:SSZ
| |
| − | * <code>EndTime</code> '''MANDATORY''' - Format: YYYY-MM-DDTHH:MM:SSZ
| |
| − | * <code>Comment</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Suppress Service Notifications===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Implements a downtime for a service on CheckMK to temporarily stop notifications
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | * <code>StartTime</code> '''MANDATORY''' - Format: YYYY-MM-DDTHH:MM:SSZ
| |
| − | * <code>EndTime</code> '''MANDATORY''' - Format: YYYY-MM-DDTHH:MM:SSZ
| |
| − | * <code>ServiceDescriptions</code> '''MANDATORY''' - The service description
| |
| − | * <code>Comment</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Delete Downtimes===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This api call will remove all downtimes for the specified host, service or both if both are provided.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | * <code>ServiceDescriptions</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Create A New CheckMK User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Create a new User for your CheckMK site
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>NewUser</code> '''MANDATORY''' -
| |
| − | * <code>FullName</code> -
| |
| − | * <code>UserPassword</code> -
| |
| − | * <code>DisableLogin</code> -
| |
| − | * <code>EmailAddress</code> -
| |
| − | * <code>Roles</code> -
| |
| − | * <code>ContactGroup</code> -
| |
| − | * <code>DisableNotifications</code> -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Update A Existing CheckMK User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Updates the specified Check MK User
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | * <code>UserPassword</code> -
| |
| − | * <code>FullName</code> -
| |
| − | * <code>DisableLogin</code> '''MANDATORY''' -
| |
| − | * <code>EmailAddress</code> -
| |
| − | * <code>DisableNotifications</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>id</code>
| |
| − | * <code>fullName</code>
| |
| − | * <code>disableLogin</code>
| |
| − | * <code>email</code>
| |
| − | * <code>roles</code>
| |
| − | * <code>contactGroups</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Delete A CheckMK User===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This function will remove a Check MK user from your site
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Get User Information===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Get User details from CheckMK
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>id</code>
| |
| − | * <code>fullName</code>
| |
| − | * <code>disableLogin</code>
| |
| − | * <code>email</code>
| |
| − | * <code>roles</code>
| |
| − | * <code>contactGroups</code>
| |
| − | * <code>outcome</code> The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Create A CheckMK Contact Group===
| |
| − | <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
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> '''MANDATORY''' - Please do not use any blank spaces
| |
| − | * <code>Alias</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>id</code>
| |
| − | * <code>contactGroupConfig</code>
| |
| − | * <code>title</code>
| |
| − | * <code>member</code>
| |
| − | * <code>alias</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Delete A CheckMK Contact Group===
| |
| − | <div class="mw-collapsible-content">
| |
| − | This function allows you to delete a contact group from your site.
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Name</code> '''MANDATORY''' - Please do not use any blank spaces
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Activate Site Changes===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Activate changes to site
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Redirect</code> '''MANDATORY''' -
| |
| − | * <code>Sites</code> -
| |
| − | * <code>Force_Foreign_Changes</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>domainType</code>
| |
| − | * <code>id</code>
| |
| − | * <code>title</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Create A CheckMK Host===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Create a new CheckMK Host
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | * <code>ipAddress</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Update A CheckMK Host Name===
| |
| − | <div class="mw-collapsible-content">
| |
| − | 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====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | * <code>NewHostName</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Delete A CheckMK Host===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Use the Host name to remove the host from the Site
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>Hostname</code> '''MANDATORY''' -
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Add Roles To A CheckMK User===
| |
| − | <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
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | * <code>Roles</code> '''MANDATORY''' - Separate each value with a comma
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Remove Roles From A CheckMK User===
| |
| − | <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
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | * <code>Roles</code> '''MANDATORY''' - Separate each value with a comma
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Remove A CheckMK User From A Contact Group===
| |
| − | <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
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | * <code>ContactGroup</code> '''MANDATORY''' - Separate each value with a comma
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>id</code>
| |
| − | * <code>fullName</code>
| |
| − | * <code>roles</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Add A CheckMK User To A Contact Group===
| |
| − | <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
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>User</code> '''MANDATORY''' -
| |
| − | * <code>ContactGroup</code> '''MANDATORY''' - Separate each value with a comma
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>id</code>
| |
| − | * <code>fullName</code>
| |
| − | * <code>contactGroups</code>
| |
| − | * <code>outcome</code> '''MANDATORY''' The outcome of the operation (OK/FAIL)
| |
| − | * <code>errors</code> Any errors returned by the operation
| |
| − | | |
| − | </div></div>
| |
| − | | |
| − | | |
| − | [[Category:ITOM]] | |
