Difference between revisions of "Dynatrace ITOM"

From Hornbill
Jump to navigation Jump to search
 
(2 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]] > Dynatrace ITOM|[[: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:dynatrace_logo.png|dynatrace_logo.png|250px]]
 
{{IntroAndLinks|The Dynatrace package for Hornbill's IT Operations Management (ITOM) contains an administrative operation that allows you to manage Problems in your on-premise Dynatrace 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:Dynatracemanaged_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/8/8e/Dynatracemanaged_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 Dynatrace.
 
 
 
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 '''Dynatrace''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
 
 
 
* In the Admin console, navigate to: System > Security > KeySafe;
 
* In the '''Type''' field, select <code>Dynatrace Managed</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 Token - this should be populated with an API Token generated against a Dynatrace account with permission to be able to perform the selected operations;
 
* Endpoint - this should be populated with the API Endpoint for your Dynatrace instance. For example: https://{your-domain}/e/{your-environment-id}/api/v1 where {your-domain} should be replaced by the host domain of the Dynatrace instance, and {your-environment-id} should be replaced with your Dynatrace environment ID.
 
* Click '''Create Key''' to save
 
 
 
See screenshots to the right for examples.
 
 
 
==Package Operations==
 
[[File:dynatrace_job.png|300px|right|link=https://wiki.hornbill.com/images/b/b2/Dynatrace_job.png]]
 
The Dynatrace 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. 
 
 
 
===Problem Comment===
 
 
 
This operation can be used to add a Comment to a Dynatrace Problem.
 
 
 
====Extra Credentials====
 
 
 
This operation requires an extra credential to be provided:
 
 
 
* Credential Reference: <code>credential1</code>
 
* Credential Keysafe Key Type: <code>Dynatrace Managed</code>
 
 
 
====Input Parameters====
 
 
 
* <code>ProblemID</code> '''(MANDATORY)''' - The ID of the Problem to add the Comment to
 
* <code>Comment</code> '''(MANDATORY)''' - The body of the Comment
 
* <code>Context</code> - The context of the comment. It can contain any additional information
 
* <code>User</code> - The author of the comment
 
 
 
====Output Parameters====
 
 
 
* <code>errors</code> - Any errors returned by the operation.
 
* <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
 
* <code>commentId</code> - The ID of the Comment that was created
 
 
 
===Problem Close===
 
 
 
This operation can be used to Close a Dynatrace Problem.
 
 
 
====Extra Credentials====
 
 
 
This operation requires an extra credential to be provided:
 
 
 
* Credential Reference: <code>credential1</code>
 
* Credential Keysafe Key Type: <code>Dynatrace Managed</code>
 
 
 
====Input Parameters====
 
 
 
* <code>ProblemID</code> '''(MANDATORY)''' - The ID of the Problem to add the Comment to
 
* <code>Comment</code> '''(MANDATORY)''' - The body of the Comment
 
 
 
====Output Parameters====
 
 
 
* <code>errors</code> - Any errors returned by the operation.
 
* <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
 
* <code>commentId</code> - The ID of the Comment that was created
 
* <code>closing</code> - The problem is in process of closing (true) or closed (false).
 
 
 
[[Category:ITOM]]
 

Latest revision as of 18:41, 11 April 2024

This document can now be found at its new location in the Hornbill Document Library.

   ITOM Package Reference