Difference between revisions of "ITOM Quick Start Guide"

From Hornbill
Jump to navigation Jump to search
(Created page with "# ITOM Quick Start Guide A quick guide to getting you up and running Hornbills ITOM offering provides the tools required for you to efficiently manage your computing devices...")
 
(Blanked the page)
Line 1: Line 1:
# ITOM Quick Start Guide
 
  
A quick guide to getting you up and running
 
 
Hornbills ITOM offering provides the tools required for you to efficiently manage your computing devices with the following features:
 
 
- Device Discovery and Inventory management
 
- Packaged Job deployment and Scheduling
 
- Orchestration provided via the use of Runbooks
 
- Dynamic Package Library, Custom Package Creation
 
 
# Site integration Service (SIS) Installation
 
 
The service is required to be installed on premise and must have access to all devices that you wish to be managed. The role of SIS server service is to monitor the ITOM Job Queue and downloading any Jobs targeted for it. It will also handle the deploying of packages to remote devices and executing the payload.
 
 
## Minimum requirements
 
 
OS: Windows Server 2012, 2012 R2, 2016 or 2019
 
 
RAM: 4GB
 
 
Free Disk: 10GB
 
 
There is a minimal CPU load and will run on virtual as well as physical machines.
 
 
## Where to Install
 
 
You can install the service on any existing Windows computer running one of the supported OS's. The SIS is not processor intensive and will not require significant disk usage.
 
 
We would recommend that the SIS is not installed on a Domain Controller or Desktop OS.
 
 
## Create a Default SIS Group (Required)
 
 
1. Select the Group Drop Down
 
2. Select **+Create Group**
 
3. Enter a name for the group
 
4. Click Apply
 
 
## Register a Site Integration Server
 
 
SIS Instances are grouped together to provide redundancy and performance benefits, at least one default group must be created.
 
 
1. From the ITOM page select **Site Integration Services**
 
2. Click ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) button
 
3. Enter your required details:
 
 
- Name - name used to identify the SIS server to the Hornbill Instance
 
- Group - Should be a least one default group, others can be selected via drop down if created previously
 
 
1. Click the **Create Site Integration Service** button
 
 
[![](RackMultipart20200423-4-1qbkift_html_d2f23c2e136bfb1f.png)](http://devwiki.internal.hornbill.com/index.php/File:SISAuthKey.png)
 
 
1. The Authorisation Key is displayed, and should be recorded for later use
 
2. Return to the **Site Integration Services** list
 
3. Select the **Not Paired** filter
 
 
**HORNBILL HINT:**  The Authorisation Key is temporary and will expire after 1 hour AND the SIS record is removed and will need recreating.
 
 
## Download SIS and install on a server
 
 
1. From the **Site Integration Services** list, Click the **Download Site Integration Server**
 
2. Locate and Execute the Downloaded executable
 
 
![](RackMultipart20200423-4-1qbkift_html_8da0d1f3cddc0673.png)
 
 
1. Click Install
 
2. Click Ok to Confirm the Installation
 
3. Close the Install dialog
 
4. Open the Services MMC Console
 
5. Start the **EspSisService**
 
 
![](RackMultipart20200423-4-1qbkift_html_2e624106a193d4e0.png)
 
 
## SIS Server Pairing
 
 
1. Switch back to the Browser and refresh the page (http://localhost :11117)
 
 
![](RackMultipart20200423-4-1qbkift_html_f682ef1f6dcdfa45.png)
 
 
1. Enter the instance ID
 
2. Enter the Authorization Code recorded earlier
 
3. Click the **Pair with Instance**
 
 
![](RackMultipart20200423-4-1qbkift_html_358813254643812a.png)
 
 
# Creating admin credentials in Keysafe
 
 
1. From the Hornbill Administration page Select System \> Security \> KeySafe
 
2. Click the ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) button
 
3. Select Type as **Username + Password**
 
 
![](RackMultipart20200423-4-1qbkift_html_8823918b01339490.png)
 
 
1. Enter the following Details:
 
 
Title: **Network Admin**
 
 
Domain Username (example_: DOMAIN\Username or username@domain_)
 
 
Password
 
 
1. 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
 
 
## Monitor
 
 
![](RackMultipart20200423-4-1qbkift_html_d02df2d1bb58d8fa.png)
 
 
Review the **Console** output locate e and confirm the following:
 
 
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 where detected and where able to be accessed.
 
 
# Inventory Viewer
 
 
1. Navigate to the ITOM Inventory (_ **Home \> ITOM \> Inventory Viewer** _)
 
2. Select ![](RackMultipart20200423-4-1qbkift_html_db299656542eb381.png)
 
 
![](RackMultipart20200423-4-1qbkift_html_910f1ce62324f281.png)
 
 
1. Select All Discovered Devices
 
 
![](RackMultipart20200423-4-1qbkift_html_121f53a9ff373728.png) ![](RackMultipart20200423-4-1qbkift_html_db299656542eb381.png)
 
 
1. Click the **Register** button
 
2. Click **Yes** to confirm
 
3. Select **All Managed Inventory**
 
 
## Inventory Properties
 
 
1. Click on the **Name** of a Managed inventory Item
 
2. Review the properties
 
 
## Managed Lists
 
 
1. Navigate to (_ **Home \> ITOM \> Inventory Viewer** _)
 
2. From the Show filter Select **+ Create List**
 
3. Enter a name for the List: **Test Servers**
 
4. From the Inventory Viewer select two or more Windows Servers
 
5. Click the **Add to Managed List** button
 
 
![](RackMultipart20200423-4-1qbkift_html_cb0832c0be90b639.png)
 
 
1. Select the **Test Servers** list and Click **Apply** button
 
 
# Installed Packages
 
 
Navigate to (Home \> ITOM \> Installed Packages)
 
 
## P ![](RackMultipart20200423-4-1qbkift_html_d0aba7247e463b23.png) ackage Library
 
 
1. Click the **Package Library** button
 
 
![](RackMultipart20200423-4-1qbkift_html_b29c05ff96fd6e9b.png)
 
 
1. Click **Install** on both the Active Directory Group and User Management packages
 
2. Click **Install** on Windows Disk Cleanup
 
3. Click **Close**
 
 
## U ![](RackMultipart20200423-4-1qbkift_html_831f57c41a887ecf.png) ploading 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
 
 
![](RackMultipart20200423-4-1qbkift_html_2ecf824aaf687cfa.png)
 
 
# 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
 
 
![](RackMultipart20200423-4-1qbkift_html_694b704ac32f4fe6.png)
 
 
Confirm job executed Successfully
 
 
### Console Output
 
 
Displays the package output as would be displayed if package were manually executed within the cmd console on the target device.
 
 
### Debug Log
 
 
Note any errors, success here implies that the package executed successfully, the output will be dependant 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**
 
 
![](RackMultipart20200423-4-1qbkift_html_9b18c0c1220f6cfc.png)
 
 
1. Click on a Job **Name** to view the Individual Child Job
 
2. Click Parent Link in the Summary to Return to Parent Job
 
 
![](RackMultipart20200423-4-1qbkift_html_55f97c439b96ad46.png)
 
 
# 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)**
 
 
![](RackMultipart20200423-4-1qbkift_html_65033a8fb0b1d5d9.png)
 
 
1. Wait for the Job schedule Time, and Click on the _AD Discovery_ Job **Name**
 
2. Click the **Job History**
 
3. Click on the _Scheduled AD Discover_ **Name**
 
 
## IT Automation
 
 
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**
 
 
1. Ensure **Next Scheduled Date and Time** is set to a couple of minutes in the future
 
2. Click **Enable Schedule**
 
3. **Navigate to (**_ **Home \> ITOM \>** _ **Job Scheduling)**
 
4. Wait for the Job schedule Time, and Click on the Job Name **: Windows Disk Cleanup**
 
5. Click **Job History**
 
 
![](RackMultipart20200423-4-1qbkift_html_334ebade01a0ab80.png)
 
 
1. Click on the Job Name **: Windows Disk Cleanup** (with the highest Job Id)
 
 
![](RackMultipart20200423-4-1qbkift_html_569d99c44db73578.png)
 
 
1. Review the list of jobs, and confirm that all are successful
 
2. Click on the Name of any Job entry in the list and review the Details
 
3. To return to the parent Click the link shown in the **Summary** section
 
 
# Runbooks
 
 
## Create a Runbook Process
 
 
1. F ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) rom the ITOM page, select **Runbooks**
 
2. Click the button
 
3. Enter a **Name**
 
 
![](RackMultipart20200423-4-1qbkift_html_2b4571927de7c08a.png)
 
 
### Build a Runbook Process
 
 
1. Select the connection line between the **Start** and **End** nodes
 
2. Right click on the selected line and select " **Add node between connected nodes**"
 
 
![](RackMultipart20200423-4-1qbkift_html_25a0ca9f84ca1129.png)
 
 
1. Select **IT Automation**
 
 
![](RackMultipart20200423-4-1qbkift_html_b26a9b166695784c.png) ![](RackMultipart20200423-4-1qbkift_html_53f7bef04eab4f29.png)
 
 
1. Hover over the **IT Automation** node, and click on the **Settings** icon
 
 
![](RackMultipart20200423-4-1qbkift_html_8b4fe1e64851fc7d.png)
 
 
1. Enter **Run Harry** as the Display name
 
 
![](RackMultipart20200423-4-1qbkift_html_8b4fe1e64851fc7d.png)
 
 
1. Click the **Add Package** button
 
 
![](RackMultipart20200423-4-1qbkift_html_164fd424f3a954f9.png)
 
 
1. Select **Harry Hornbill**
 
2. Confirm the Run Operation is set to **Show Harry**
 
3. Set Target Machine type to **Machine** , and select a Computer
 
4. C ![](RackMultipart20200423-4-1qbkift_html_999565301c8e41b2.png) lick **Save draft** button
 
 
### P ![](RackMultipart20200423-4-1qbkift_html_c260cdfdc25fac3.png) ublish a Runbook Process
 
 
1. Click the **Publishing Manager** button
 
 
![](RackMultipart20200423-4-1qbkift_html_7a5ee7de30ecf3cb.png)
 
 
###
 
 
###
 
 
###
 
 
1. Click the **Publish** button
 
2. Click **Runbooks** from the breadcrumbs at the top of the page
 
 
### Manually Execute a Runbook Process
 
 
1. Locate the Runbook Entry on the Runbooks list
 
2. C ![](RackMultipart20200423-4-1qbkift_html_98db734cb2992614.png) lick the **Invoke** action button
 
3. Click **Invoke**
 
 
### Schedule a Runbook Process
 
 
1. Navigate to (_ **Home \> ITOM \>** _ **Job Scheduling** )
 
2. Click the **Create New** button, and Select **Runbook Schedule**
 
3. Enter the following Schedule details:
 
  1. Name: **Harry Hornbill**
 
  2. Schedule: **Run Once**
 
  3. Runbook: **Run Harry**
 
  4. Set the following Operation Parameters to **True** :
 
4. Click **Enable Schedule**
 
5. **Navigate to (**_ **Home \> ITOM \>** _ **Job Scheduling)**
 
6. Wait for the Job schedule Time, and Click on the Job Name **:**  **Harry Hornbill**
 
7. Click **Job History**
 
8. Confirm the Status of the Job
 
 
# Service Manager Interaction
 
 
## Hornbill Business Process Manager
 
 
## Runbook Process
 
 
1. Navigate to ([_ **Home** _](https://betaadmin.hornbill.com/rickyf/) _ **\>  ** _[_ **Applications** _](https://betaadmin.hornbill.com/rickyf/app/)_ ** \>** _ [_ **Hornbill Service Manager** _](https://betaadmin.hornbill.com/rickyf/app/com.hornbill.servicemanager/)_ ** \>** _ _ **Business Processes** _)
 
2. Locate **EXAMPLE Hornbill Incident Process** and click the **Copy Process** action button
 
3. Enter the name **Demo Business Process** , and click **Apply**
 
4. Select the Connector between the **Start** and **Set Status to New** nodes
 
5. Right Click and Select **Runbook Process**
 
6. Double click on the new node
 
7. Select **Run Harry** from the Runbook drop down
 
8. Click Save
 
9. Publish the Business Process \*\* Needs work \*\*\*
 
10. Assign the new process to an Incident \*\* Needs work \*\*\*
 
11. Raise an Incident
 
 
## IT Automation
 
 
1. Navigate to ([_ **Home** _](https://betaadmin.hornbill.com/rickyf/) _ **\>  ** _[_ **Applications** _](https://betaadmin.hornbill.com/rickyf/app/)_ ** \>** _ [_ **Hornbill Service Manager** _](https://betaadmin.hornbill.com/rickyf/app/com.hornbill.servicemanager/)_ ** \>** _ _ **Business Processes** _)
 
2. Locate **Demo Business Process** and click the link under Workflow
 
3. Right Click the **Runbook Process** node, and select **Delete**
 
4. Add a new node by dragging the **Arrow** underneath the **Start** node to a blank area and releasing
 
5. Select **IT**** Automation**
 
6. Double click on the new node
 
7. Select Run Package as **Demonstration \> Harry Hornbill ...**
 
8. Click **Apply**
 
9. Set Target Machine type to **Machine** , and select a Computer
 
10. Connect the New **IT Automation** node to the **Set status to New** node
 
11. Click **Save**
 
12. Publish the Business Process \*\* Needs work \*\*\*
 
13. Raise an Incident
 
 
# Package Creator
 
 
## Create a Simple Package
 
 
1. F ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) rom the ITOM page select Package Creator
 
2. Click button
 
3. Enter a Package name: **TCP Utilities**
 
4. Set Target OS to **Windows Universal**
 
5. Click **Add Operation** button
 
6. Enter the following details:
 
  1. Operation: **Ping**
 
  2. Description: **Ping a device using the parameters -n, host**
 
  3. Command Type: **Run Command**
 
  4. Command: **cmd /c ping.exe**
 
  5. Timeout(secs): 60
 
  6. Options/Args: **-n {param.count} {param.host}**
 
7. Click **Add Parameter** button
 
8. Set the following attributes:
 
  1. **Required**
 
  2. **Number**
 
  3. Parameter Name: **count**
 
  4. Default value: **3**
 
  5. Hint: **Number of echo requests to send.**
 
9. Click **Add Parameter** button
 
10. Set the following attributes:
 
  1. **Required**
 
  2. **string**
 
  3. Parameter Name: **host**
 
  4. Hint: **Target device hostname.**
 
11. Click **Apply**
 
12. Click **Baseline** button
 
13. Select **Version 1** via the Drop Down Adjacent to the **Baseline** button
 
14. Click **Package and Install** drop down, and select **Package and Install**
 
15. Navigate to ( **Home \> ITOM \> Job Queue** )
 
16. Click **Create New** button, and select **IT Automation Job**
 
17. Select Run Package: **private:{** _ **instance-name** _**} \> General Purpose \> TCP Utilities (Version 1)**
 
18. Click **Apply**
 
19. Enter the following details:
 
 
  1. Name: **Ping Computer**
 
  2. Run Operation: **ping**
 
  3. Site Target: **Server | \<SIS Server\>**
 
  4. Target Machine: **Inventory |\<target computer\>**
 
  5. Admin Credentials
 
 
1. Click **Create**
 
 
## Windows Installer Package
 
 
1. F ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) rom the ITOM page select Package Creator
 
2. Click button
 
3. Enter a Package name: **Software Installer**
 
4. S ![](RackMultipart20200423-4-1qbkift_html_be909e11db126955.png) et Target OS to **Windows Universal**
 
5. Click **Upload File** button
 
6. Select the following file:
 
 
**C:\ Documents\ITOM\Packages\Demo.msi**
 
 
1. Click on **Package Info**
 
2. Click **Add Operation** button
 
3. Enter the following details:
 
  1. Operation: **Install**
 
  2. Description: **Install Windows application**
 
  3. Command Type: **Windows Installer**
 
  4. Package: **Demo.msi**
 
  5. Action: **Install Software**
 
4. Click **Add**
 
5. Click **Add Operation** button
 
6. Enter the following details:
 
  1. Operation: **Uninstall**
 
  2. Description: **Unin**** stall Windows application**
 
  3. Command Type: **Windows Installer**
 
  4. Package: **Demo.msi**
 
  5. Action: **Uninstall Software**
 
7. Click **Add**
 
8. Click **Baseline** button
 
9. Select **Version 1** via the Drop Down Adjacent to the **Baseline** button
 
10. Click **Package and Install** drop down, and select **Package and Install**
 
 
### Execute Installation Job
 
 
1. Navigate to ( **Home \> ITOM \> Job Queue** )
 
2. Click **Create New** button, and select **IT Automation Job**
 
3. Select Package:
 
 
**private:{** _ **instance-name** _**} \> General Purpose \> Software Installer (Version 1)**
 
 
1. Click **Apply**
 
2. Enter the following details:
 
 
  1. Name: **Software Installation**
 
  2. Run Operation: **Install**
 
  3. Site Target: **Server | \<SIS Server\>**
 
  4. Target Machine: **Inventory |\<target computer\>**
 
  5. Admin Credentials: **\<relevant KeySafe entry\>**
 
 
1. Click **Create**
 
2. Verify that the following software exists on the target:
 
 
Name: **Generic Business Application**
 
 
Publisher: **Acme Software Ltd**
 
 
### Execute Uninstallation Job
 
 
1. Navigate to ( **Home \> ITOM \> Job Queue** )
 
2. Click **Create New** button, and select **IT Automation Job**
 
3. Select Package:
 
 
**private:{** _ **instance-name** _**} \> General Purpose \> Software Installer (Version 1)**
 
 
1. Click **Apply**
 
2. Enter the following details:
 
 
  1. Name: **Software Uninstallation**
 
  2. Run Operation: **UniInstall**
 
  3. Site Target: **Server | \<SIS Server\>**
 
  4. Target Machine: **Inventory |\<target computer\>**
 
  5. Admin Credentials: **\<relevant KeySafe entry\>**
 
 
1. Click **Create**
 
2. Verify that the following the software no longer exists on the target:
 
 
Name: **Generic Business Application**
 
 
Publisher: **Acme Software Ltd**
 
 
## Windows Executable
 
 
1. F ![](RackMultipart20200423-4-1qbkift_html_7be719736b3ad1e.png) rom the ITOM page select Package Creator
 
2. Click button
 
3. Enter a Package name: **Windows Executable**
 
4. Set Target OS to **Windows Universal**
 
5. Click **Upload File** button
 
6. Select the following file:
 
 
**C:\ Documents\ITOM\Packages\ShowHarry.exe**
 
 
1. Click on **Package Info**
 
2. Click **Add Operation** button
 
3. Enter the following details:
 
  1. Operation: **Show Harry**
 
  2. Description: **Windows Executable - Show Harry.exe**
 
  3. Command Type: **Windows Executable**
 
  4. Run File: **ShowHarry.exe**
 
4. Click **Add**
 
5. Click **Baseline** button
 
6. Select **Version 1** via the Drop Down Adjacent to the **Baseline** button
 
7. Click **Package and Install** drop down, and select **Package and Install**
 
 
### Execute Windows Executable Job
 
 
1. Navigate to ( **Home \> ITOM \> Job Queue** )
 
2. Click **Create New** button, and select **IT Automation Job**
 
3. Select Run Package: **private:{** _ **instance-name** _**} \> General Purpose \> Windows Executable (Version 1)**
 
4. Click **Apply**
 
5. Enter the following details:
 
 
  1. Name: **Windows Executable**
 
  2. Run Operation: **Show Harry**
 
  3. Site Target: **Server | \<SIS Server\>**
 
  4. Target Machine: **Inventory |\<target computer\>**
 
  5. Admin Credentials
 
 
1. Click **Create**
 
 
## Batch Script
 
 
## PowerShell Script
 
 
# Trouble Shooting
 
 
# Site Integration Server
 
 
## Rename server
 
 
##
 
 
# Appendix A
 
 
Required User Rights
 
 
Add these two rights to be able to Run AS
 
 
Missing privilege: Replace a process-level token. (SeAssignPrimaryTokenPrivilege)
 
Missing privilege: Act as part of the operating system. (SeTcbPrivilege)
 
 
![](RackMultipart20200423-4-1qbkift_html_1d4f5e2115d426ec.png)
 
 
![](RackMultipart20200423-4-1qbkift_html_adbb807b4e78aee4.png)
 

Revision as of 09:31, 23 April 2020