Rundeck ITOM

From Hornbill
Revision as of 15:59, 17 March 2020 by SteveGoldthorpe (talk | contribs) (→‎KeySafe Configuration)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Home > Administration > IT Operations Management > ITOM Package Library > Rundeck ITOM Index

Rundeck-logotype-512.png

Introduction

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 Articles

Target Environment Requirements

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 PowerShell Documentation for more information.

KeySafe Configuration

Itomtarget keysafe.png
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 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.

To configure your API Key account authentication in KeySafe:

  • In the Admin console, navigate to: System > Security > KeySafe;
  • In the Type field, select API Key
  • 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

Rundeck job.png

The Rundeck 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.

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: credential1
  • Credential Keysafe Key Type: API Key

Input Parameters

  • JobID (MANDATORY) - The ID of the Job to Execute

Output Parameters

  • errors - Any errors returned by the operation.
  • outcome - Outcome of the operation. Can be OK or FAIL.
  • executionId - The ID of the Execution
  • status - The current Status of the Execution
  • permalink - 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: credential1
  • Credential Keysafe Key Type: API Key

Input Parameters

  • ExecutionID (MANDATORY) - The ID of the Job Execution

Output Parameters

  • errors - Any errors returned by the operation.
  • outcome - Outcome of the operation. Can be OK or FAIL.
  • status - The current Status of the Execution
  • permalink - 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: credential1
  • Credential Keysafe Key Type: API Key

Input Parameters

  • ExecutionID (MANDATORY) - The ID of the Job Execution

Output Parameters

  • errors - Any errors returned by the operation.
  • outcome - Outcome of the operation. Can be OK or FAIL.
  • output - The Output of the Execution