ITOM Quick Start Guide

Home > Administration > ITOM > Quick Start Guide

Index

Introduction This guide takes you through the steps required to get ITOM up and running, from installing your first Site Integration Server to Discovery and Package execution. To follow this guide, you must have access to an instance, and a user with the ITOM Administrator role added a suitable Windows computer on which to install the SIS. Minimum requirements OS: Windows Server (64bit) 2012, 2012 R2, 2016 or 2019 RAM: 4GB Free Disk: 10GB

Related Articles ITOM Runbooks Quick Guide ITOM Package Creator Quick Guide ITOM Package Examples IT Operations Management ITOM Package Library

Site integration Service (SIS) Installation

The service's role is to monitor the ITOM Job Queue and download any Jobs targeted for it. It will also handle the discovery of devices, deploy and execute packages on those devices. The service is available for download via the Hornbill Instance and installed at any time; however, before you can use it, a Site connector will need to exist on the Hornbill Instance and the SIS paired with it.

The service is installed on-premise behind the firewall and must have access to all devices required for discovery and package deployment. For redundancy, security, or if devices exist on non-connected networks, you can deploy multiple services. The SIS is not processor intensive and will not require significant disk usage, and you can install the service on any existing Windows computer running one of the supported OS’s. We would recommend for you not to install it on a Windows Domain Controller.

The following set of steps will guide you through the process of getting your SIS up and running:

Adding an SIS Connector

First lets setup an SIS connector and generate the Authorisation key required for the pairing process.

1. From the ITOM page select Site Integration Services
2. Click the “Add SIS connector” button
3. Enter your required details:
   1. Name - Unique identifer for the SIS Connector
   2. Group - The default group can be used
4. Click the Create Site Integration Service button

1. Make a note of the Authorisation Key, required for later use during the pairing process

5. Return to the Site Integration Services list
6. Select the Not Paired filter

The Authorisation Key is temporary and will expire after 1 hour, AND the SIS record will need recreating.

Download and Installation of the SIS

You can download the SIS installation file from the ITOM admin tool and copy it to the required installation locations.

1. From the Site Integration Services list, Click the Download Site Integration Server button
2. Locate and Execute the Downloaded executable

3. Click Install
4. Click OK to Confirm the Installation
5. Close the Install dialog

The service will not be started automatically you must manually start the process or configure it to be automatically started.

6. Open the Services MMC Console
7. Start the EspSisService

Server Pairing

Once the service has been started the pairing process can be completed via the service web page. Once pairing is successful the page will provide SIS status information and will be accessible at all times.

1. Switch back to the Browser and refresh the page (http://localhost:11117)

2. Enter the instance ID
3. Enter the Authorization Code recorded earlier
4. Click the Pair with Instance button

ITOM Admin Account Requirements

Windows NT Accounts

ITOM Admin Credentials will require a Windows NT Administrator account with the following additional rights to be applied:

• Replace a process-level token. (SeAssignPrimaryTokenPrivilege)
• Act as part of the operating system. (SeTcbPrivilege)

You should create a new account solely to deploy and execute ITOM packages. With the above additional privileges, the account will require relevant rights/permissions to access computers over the network. Additional accounts may also require creation; these are dependent on the package used and the security context that the job should be to run as; further information is available within the ITOM package library documented for each package under the section KeySafe Configuration. (https://wiki.hornbill.com/index.php/ITOM_Package_Library)

Creating a Hornbill KeySafe entry

1. From the Hornbill Administration page navigate to (Home > System > Security > KeySafe)
2. Click the Create New Key button
3. Select Type as Username + Password

Ensure that the KeySafe entry type is Username + Password and not Username + Password + Pre-Shared Key, as the entry will not be visible within ITOM

1. 

4. Enter the following details:

1. Title: Network Admin
2. Domain Username: (example: DOMAIN\Username or username@domain)
3. Password:

5. Click Create Key

Configuring a Discover Job

1. Navigate to the ITOM Job Queue (Home > ITOM > Job Queue)

2. Click the Create New button and select Discovery Job

3. Enter the following details:

   1. Name: AD Discovery using DCOM

   2. Site Target: [Server] SIS Demo

   3. Protocol: DCOM

   4. Discovery Mode: Active Directory

   5. Container: train1. hornbill.edu

   6. Admin Credentials: Network Admin

   7. Use Default Ping Check Settings

4. Click Create button

Review the Console output locate and confirm the following:

Monitor:

Enumerating child OU
Scan found X computers for detailed discovery. Performing WMI discovery of X computers

Summary
=======
Successful Discovery
All Computers

The discovery was executed successfully. The results are now being imported.

10:11:26 Discovery import complete. Added:X Updated:X Skipped:X Missing:X Failed:X

Console Output:

Review Summary, confirming successful discovery, and noting any failures.

Debug:
Note any errors; success here implies that the Discovery process did not fail and not that all devices were detected and were able to be accessed.

Inventory Viewer

1. Navigate to the ITOM Inventory (Home > ITOM > Inventory Viewer)
2. Select All Un-Managed Inventory

3. Click on the Name of an Un-Managed inventory Item

4. Click check next to the heading Name to select All Discovered Devices

5. Click the Register button
6. Click Yes to confirm
7. Select All Managed Inventory

Inventory Properties

1. Click on the Name of a Managed inventory Item

   

2. Review the properties

Installed Packages

Package Library

1. Navigate to (Home > ITOM > Installed Packages)
2. Click the Package Library button

2. Click Install on both the Active Directory Group and User Management packages

3. Click Install on Windows Disk Cleanup

4. Click Close

Uploading Packages

1. Click the Package Upload button
2. Select the provided package file: Demo.pkg
3. Click Open
4. Repeat for all other provided packages

IT Automation Job

Single Computer

1. Navigate to (Home > ITOM > Job Queue)
2. Click the Create New button, and select IT Automation
3. Enter Name: Harry Hornbill on Single Computer
4. Click the Installed Packages button
5. Select Training > Demonstration > Harry Hornbill – The Bird, The Legend
6. Click Apply
7. Set Site Target to Server and select an Instance
8. Set Target Device to Inventory and select a Device
9. Set Admin Credentials to Network Admin
10. Click Create

Monitor:

Confirm job executed Successfully

Console Output:

Displays the output as would be displayed if the package were manually executed from within a “cmd” console on the target device.

Debug Log:

Note any errors; success here implies that the package is executed successfully. The output will depend on the package being executed.

Multiple Computers

1. Navigate to (Home > ITOM > Job Queue)
2. Click the Create New button, and select IT Automation
3. Enter Name: Harry Hornbill on Multiple Computers
4. Click the Installed Packages button
5. Select Training > Demonstration > Harry Hornbill – The Bird, The Legend
6. Click Apply
7. Set Site Target to Server and select an Instance
8. Set Target Device to Inventory and select a Device
9. Set Admin Credentials to Network Admin
10. Click Create

11. Click on a Job Name to view the Individual Child Job

12. Click Parent Link in the Summary to Return to Parent Job

Job Scheduling

Discovery

1. Navigate to (Home > ITOM > Job Scheduling)
2. Click the Create New button, and Select Discovery Schedule
3. Enter the following details:
   • Name: AD Discover
   • Schedule: Run Every Period
   • Every (n) Minutes: 15
   • Description: Scheduled AD Discovery
   • Site Target: Server | SIS Instance
   • Protocol: DCOM
   • Discovery Mode: Active Directory
   • Container: horbnbill.edu
   • Admin Credentials: Network Admin
4. Ensure Next Scheduled Date and Time is set to a couple of minutes in the future
5. Click Enable Schedule
6. Navigate to (Home > ITOM > Job Scheduling)

7. Wait for the Job schedule Time, and Click on the AD Discovery Job Name

8. Click the Job History

9. Click on the Scheduled AD Discover Name

IT Automation

Windows Disk cleanup

1. Navigate to (Home > ITOM > Job Scheduling)
2. Click the Create New button, and Select IT Automation Schedule
3. Enter the following Schedule details:
   • Name: Windows Disk Cleanup
   • Schedule: Run daily
4. Ent the following IT Automation Job Settings:
   • Package: private:hornbill > Disk Cleanup > Windows Disk Cleanup
   • Site Target: SIS Server
   • Target Device: List| Test Servers
   • Admin Credentials: Network Admin
   • Reference: Demo Job
   • Set the following Operation Parameters to True:

InternetCacheFiles, Recycle Bin, and Temporary Files

5. Ensure Next Scheduled Date and Time is set to a couple of minutes in the future

6. Click Enable Schedule

7. Navigate to (Home > ITOM > Job Scheduling)

8. Wait for the Job schedule Time, and Click on the Job Name: Windows Disk Cleanup

9. Click Job History

10. Click on the Job Name: Windows Disk Cleanup (with the highest Job Id)

11. Review the list of jobs, and confirm that all are successful

12. Click on the Name of any Job entry in the list and review the Details

13. To return to the parent Click the link shown in the Summary section