|
|
| Line 1: |
Line 1: |
| − | {{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Rundeck 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:Rundeck-logotype-512.png|250px]]
| |
| − | {{IntroAndLinks|The Rundeck package for Hornbill's IT Operations Management (ITOM) contains an administrative operation that allows you to manage Jobs and Job Executions in your on-premise Rundeck 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]] |
| − | | |
| − | ===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:Rundeck_api_key.png|300px|right|link=https://wiki.hornbill.com/images/f/fa/Rundeck_api_key.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 Rundeck.
| |
| − | | |
| − | 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 '''API Key''' 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 Rundeck 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 Auth Token generated against a Rundeck account with permission to be able to perform the selected operations;
| |
| − | * API Endpoint - this should be populated with the API Endpoint for your Rundeck instance. For example: https://yourrundeckserver:4440/api/32 where 4440 is the default port for Rundeck API calls, and 32 is the API version number;
| |
| − | * Click '''Create Key''' to save
| |
| − | | |
| − | See screenshots to the right for examples.
| |
| − | | |
| − | ==Package Operations==
| |
| − | [[File:rundeck_job.png|300px|right|link=https://wiki.hornbill.com/images/0/0b/Rundeck_job.png]]
| |
| − | The Rundeck 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.
| |
| − | | |
| − | ===Run Job===
| |
| − | | |
| − | This operation can be used to execute a Job on Rundeck.
| |
| − | | |
| − | ====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>JobID</code> '''(MANDATORY)''' - The ID of the Job to Execute
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation.
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
| |
| − | * <code>executionId</code> - The ID of the Execution
| |
| − | * <code>status</code> - The current Status of the Execution
| |
| − | * <code>permalink</code> - The URL to the Execution
| |
| − | | |
| − | ===Get Execution Details===
| |
| − | | |
| − | This operation can be used to execute a Job on Rundeck.
| |
| − | | |
| − | ====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>ExecutionID</code> '''(MANDATORY)''' - The ID of the Job Execution
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation.
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
| |
| − | * <code>status</code> - The current Status of the Execution
| |
| − | * <code>permalink</code> - The URL to the Execution
| |
| − | | |
| − | ===Get Execution Output===
| |
| − | | |
| − | This operation can be used to execute a Job on Rundeck.
| |
| − | | |
| − | ====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>ExecutionID</code> '''(MANDATORY)''' - The ID of the Job Execution
| |
| − | | |
| − | ====Output Parameters====
| |
| − | | |
| − | * <code>errors</code> - Any errors returned by the operation.
| |
| − | * <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
| |
| − | * <code>output</code> - The Output of the Execution
| |
| − | | |
| − | [[Category:ITOM]]
| |
