|
|
| (7 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Nagios XI|[[: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:nagios_logo.png|nagios_logo.png|250px]]
| |
| − | {{IntroAndLinks|The Nagios XI package for Hornbill's IT Operations Management (ITOM) contains a administrative operations that allows you to manage your Nagios XI deployment.
| |
| − | |
| |
| − | <!-- Related Links go here -->
| |
| − | :* [[IT_Operations_Management|IT Operations Management]]
| |
| − | :* [[Business_Process_Designer|Business Process Designer]]
| |
| − | :* [[Hornbill_KeySafe|KeySafe]]
| |
| − | }}
| |
| | | | |
| − | ==Target Environment Requirements==
| + | [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]] |
| − | | + | [[Category:HDOC]] |
| − | ===Script Execution Machine Requirements===
| |
| − | | |
| − | * 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 [https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6 PowerShell Documentation] for more information.
| |
| − | | |
| − | ==KeySafe Configuration==
| |
| − | [[File:Itomtarget_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/d/d2/Itomtarget_keysafe.png]] | |
| − | [[File:nagiosxi_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/2/2f/Nagiosxi_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 within your environment, and will require an additional KeySafe Key to hold the account credentials to connect to your Nagios XI deployment.
| |
| − | | |
| − | 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.
| |
| − | | |
| − | To configure your '''Nagios XI''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
| |
| − | | |
| − | * In the Admin console, navigate to: System > Security > KeySafe;
| |
| − | * In the '''Type''' field, select <code>API Key</code>
| |
| − | * Give the API Key a title (this is the name/identifier for the Dynatrace account as you will see it when using the Integration Call node in your business process);
| |
| − | * Optionally add a description;
| |
| − | * API Key - this should be populated with an API Key that has the rights to perform the operations contained within this package
| |
| − | * API Endpoint - this should be populated with the API Endpoint for your Nagios XI instance. For example: https://yournagiosxiserver/nagiosxi/api/v1
| |
| − | * Click '''Create Key''' to save
| |
| − | | |
| − | See screenshots to the right for examples.
| |
| − | | |
| − | ==Package Operations==
| |
| − | [[File:nagios_job.png|300px|right|link=https://wiki.hornbill.com/images/c/cc/Nagios_job.png]]
| |
| − | The Nagios XI 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.
| |
| − | | |
| − | ===Acknowledgements - Acknowledge Host Problem===
| |
| − | | |
| − | This operation can be used to Acknoweledge a Host Problem. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=39 Nagios XI Documentation] for more information on the action and input parameters.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | This operation requires an extra credential to be provided:
| |
| − | | |
| − | * Credential Reference: <code>credential1</code>
| |
| − | * Credential Keysafe Key Type: <code>API Key</code>
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on
| |
| − | * <code>Sticky</code> '''(MANDATORY)'''
| |
| − | * <code>Notify</code> '''(MANDATORY)'''
| |
| − | * <code>Persistent</code> '''(MANDATORY)'''
| |
| − | * <code>Author</code> '''(MANDATORY)'''
| |
| − | * <code>Comment</code> '''(MANDATORY)'''
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL
| |
| − | * <code>success</code> - the value of the success response from the Nagios operation
| |
| − | | |
| − | ===Acknowledgements - Acknowledge Service Problem===
| |
| − | | |
| − | This operation can be used to Acknoweledge a Service Problem on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | This operation requires an extra credential to be provided:
| |
| − | | |
| − | * Credential Reference: <code>credential1</code>
| |
| − | * Credential Keysafe Key Type: <code>API Key</code>
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on
| |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on
| |
| − | * <code>Sticky</code> '''(MANDATORY)'''
| |
| − | * <code>Notify</code> '''(MANDATORY)'''
| |
| − | * <code>Persistent</code> '''(MANDATORY)'''
| |
| − | * <code>Author</code> '''(MANDATORY)'''
| |
| − | * <code>Comment</code> '''(MANDATORY)'''
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL
| |
| − | * <code>success</code> - the value of the success response from the Nagios operation
| |
| − | | |
| − | ===Acknowledgements - Remove Host Acknowledgement===
| |
| − | | |
| − | This operation can be used to Remove an Acknoweledgement from a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=116 Nagios XI Documentation] for more information on the action and input parameters.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | This operation requires an extra credential to be provided:
| |
| − | | |
| − | * Credential Reference: <code>credential1</code>
| |
| − | * Credential Keysafe Key Type: <code>API Key</code>
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL
| |
| − | * <code>success</code> - the value of the success response from the Nagios operation
| |
| − | | |
| − | ===Acknowledgements - Remove Service Acknowledgement===
| |
| − | | |
| − | This operation can be used to Remove an Acknoweledgement from a Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters.
| |
| − | | |
| − | ====Extra Credentials====
| |
| − | | |
| − | This operation requires an extra credential to be provided:
| |
| − | | |
| − | * Credential Reference: <code>credential1</code>
| |
| − | * Credential Keysafe Key Type: <code>API Key</code>
| |
| − | | |
| − | ====Input Parameters====
| |
| − | | |
| − | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on
| |
| − | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL
| |
| − | * <code>success</code> - the value of the success response from the Nagios operation
| |
| − | | |
| − | [[Category:ITOM]] | |
