Difference between revisions of "ITOM Quick Start Guide"

From Hornbill
Jump to navigation Jump to search
(Blanked the page)
Line 1: Line 1:
 +
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 ==
 +
 +
<blockquote>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.
 +
</blockquote>
 +
== Where to Install ==
 +
 +
<blockquote>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.
 +
</blockquote>
 +
== Create a Default SIS Group (Required) ==
 +
 +
# Select the Group Drop Down
 +
# Select '''+Create Group'''
 +
# Enter a name for the group
 +
# Click Apply
 +
 +
== Register a Site Integration Server ==
 +
 +
<blockquote>SIS Instances are grouped together to provide redundancy and performance benefits, at least one default group must be created.
 +
</blockquote>
 +
<ol style="list-style-type: decimal;">
 +
<li><blockquote><p>From the ITOM page select '''Site Integration Services'''</p></blockquote></li>
 +
<li><blockquote><p>Click [[File:media/image1.png|28x25px|Image: 500 pixels]] button</p></blockquote></li>
 +
<li><blockquote><p>Enter your required details:</p></blockquote>
 +
<ul>
 +
<li><blockquote><p>Name - name used to identify the SIS server to the Hornbill Instance</p></blockquote></li>
 +
<li><blockquote><p>Group - Should be a least one default group, others can be selected via drop down if created previously</p></blockquote></li></ul>
 +
</li>
 +
<li><blockquote><p>Click the '''Create Site Integration Service''' button</p></blockquote></li></ol>
 +
 +
<blockquote>[[File:media/image2.png|350x79px|Image: 350 pixels]]
 +
</blockquote>
 +
<ol start="5" style="list-style-type: decimal;">
 +
<li><blockquote><p>The Authorisation Key is displayed, and should be recorded for later use</p></blockquote></li>
 +
<li><blockquote><p>Return to the '''Site Integration Services''' list</p></blockquote></li>
 +
<li><blockquote><p>Select the '''Not Paired''' filter</p></blockquote></li></ol>
 +
 +
<blockquote>'''HORNBILL HINT:''' The Authorisation Key is temporary and will expire after 1 hour AND the SIS record is removed and will need recreating.
 +
</blockquote>
 +
== Download SIS and install on a server ==
 +
 +
# From the '''Site Integration Services''' list, Click the '''Download Site Integration Server'''
 +
# Locate and Execute the Downloaded executable
 +
 +
<blockquote>[[File:media/image3.png|328x200px]]
 +
</blockquote>
 +
<ol start="3" style="list-style-type: decimal;">
 +
<li><p>Click Install</p></li>
 +
<li><p>Click Ok to Confirm the Installation</p></li>
 +
<li><p>Close the Install dialog</p></li>
 +
<li><p>Open the Services MMC Console</p></li>
 +
<li><p>Start the '''EspSisService'''</p></li></ol>
 +
 +
<blockquote>[[File:media/image4.png|411x141px]]
 +
</blockquote>
 +
== SIS Server Pairing ==
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><blockquote><p>Switch back to the Browser and refresh the page (http://localhost :11117)</p></blockquote></li></ol>
 +
 +
<blockquote>[[File:media/image5.png|252x162px]]
 +
</blockquote>
 +
<ol start="2" style="list-style-type: decimal;">
 +
<li><blockquote><p>Enter the instance ID</p></blockquote></li>
 +
<li><blockquote><p>Enter the Authorization Code recorded earlier</p></blockquote></li>
 +
<li><blockquote><p>Click the '''Pair with Instance'''</p></blockquote></li></ol>
 +
 +
<blockquote>[[File:media/image6.png|479x297px]]
 +
</blockquote>
 +
= Creating admin credentials in Keysafe =
 +
 +
# From the Hornbill Administration page Select System &gt; Security &gt; KeySafe
 +
# Click the [[File:media/image1.png|37x34px|Image: 500 pixels]]button
 +
# Select Type as '''Username + Password'''
 +
 +
<blockquote>[[File:media/image7.png|269x187px]]
 +
</blockquote>
 +
<ol start="4" style="list-style-type: decimal;">
 +
<li><p>Enter the following Details:</p></li></ol>
 +
 +
<blockquote>Title: '''Network Admin'''
 +
 +
Domain Username (example'': DOMAIN\Username or username@domain'')
 +
 +
Password
 +
</blockquote>
 +
<ol start="5" style="list-style-type: decimal;">
 +
<li><p>Click '''Create Key'''</p></li></ol>
 +
 +
= Configuring a Discover Job =
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><p>Navigate to the ITOM Job Queue ('''''Home &gt; ITOM &gt; Job Queue''''')</p></li>
 +
<li><p>Click the '''Create New''' button and select '''Discovery Job'''</p></li>
 +
<li><p>Enter the following details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Name: '''AD Discovery using DCOM'''</p></li>
 +
<li><p>Site Target: ['''Server'''] '''SIS Demo'''</p></li>
 +
<li><p>Protocol: '''DCOM'''</p></li>
 +
<li><p>Discovery Mode: '''Active Directory'''</p></li>
 +
<li><p>Container: train1. hornbill.edu</p></li>
 +
<li><p>Admin Credentials: '''Network Admin'''</p></li>
 +
<li><p>Use Default Ping Check Settings</p></li></ol>
 +
</li>
 +
<li><p>Click '''Create''' button</p></li></ol>
 +
 +
== Monitor ==
 +
 +
<blockquote>[[File:media/image8.png|468x255px]]
 +
 +
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
 +
 +
=======<br />
 +
Successful Discovery<br />
 +
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
 +
</blockquote>
 +
== Console Output ==
 +
 +
Review Summary, confirming successful discovery, and noting any failures.
 +
 +
==  Debug ==
 +
 +
<blockquote>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.
 +
</blockquote>
 +
= Inventory Viewer =
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><blockquote><p>Navigate to the ITOM Inventory ('''''Home &gt; ITOM &gt; Inventory Viewer''''')</p></blockquote></li>
 +
<li><blockquote><p>Select [[File:media/image9.png|40x36px]]</p></blockquote></li></ol>
 +
 +
<blockquote>[[File:media/image10.png|341x134px]]
 +
</blockquote>
 +
<ol start="3" style="list-style-type: decimal;">
 +
<li><blockquote><p>Select All Discovered Devices</p></blockquote></li></ol>
 +
 +
<blockquote>[[File:media/image9.png|40x36px]][[File:media/image11.png|324x156px]]
 +
</blockquote>
 +
<ol start="4" style="list-style-type: decimal;">
 +
<li><blockquote><p>Click the '''Register''' button</p></blockquote></li>
 +
<li><blockquote><p>Click '''Yes''' to confirm</p></blockquote></li>
 +
<li><blockquote><p>Select '''All Managed Inventory'''</p></blockquote></li></ol>
 +
 +
== Inventory Properties ==
 +
 +
# Click on the '''Name''' of a Managed inventory Item
 +
# Review the properties
 +
 +
== Managed Lists ==
 +
 +
# Navigate to ('''''Home &gt; ITOM &gt; Inventory Viewer''''')
 +
# From the Show filter Select '''+ Create List'''
 +
# Enter a name for the List: '''Test Servers'''
 +
# From the Inventory Viewer select two or more Windows Servers
 +
# Click the '''Add to Managed List''' button
 +
 +
<blockquote>[[File:media/image12.png|175x64px]]
 +
</blockquote>
 +
<ol start="6" style="list-style-type: decimal;">
 +
<li><p>Select the '''Test Servers''' list and Click '''Apply''' button</p></li></ol>
 +
 +
= Installed Packages =
 +
 +
<blockquote>Navigate to (Home &gt; ITOM &gt; Installed Packages)
 +
</blockquote>
 +
== [[File:media/image13.png|42x33px]]Package Library ==
 +
 +
# Click the '''Package Library''' button
 +
 +
<blockquote>[[File:media/image14.png|497x150px]]
 +
</blockquote>
 +
<ol start="2" style="list-style-type: decimal;">
 +
<li><p>Click '''Install''' on both the Active Directory Group and User Management packages</p></li>
 +
<li><p>Click '''Install''' on Windows Disk Cleanup</p></li>
 +
<li><p>Click '''Close'''</p></li></ol>
 +
 +
== [[File:media/image15.png|43x32px]]Uploading Packages ==
 +
 +
# Click the '''Package Upload''' button
 +
# Select the provided package file: '''Demo.pkg'''
 +
# Click '''Open'''
 +
# Repeat for all other provided packages
 +
 +
<blockquote>[[File:media/image16.png|433x207px]]
 +
</blockquote>
 +
= IT Automation Job =
 +
 +
== Single Computer ==
 +
 +
# Navigate to ('''''Home &gt; ITOM &gt;'' Job Queue''')
 +
# Click the '''Create New''' button, and select '''IT Automation'''
 +
# Enter Name: '''Harry Hornbill on Single Computer'''
 +
# Click the '''Installed Packages''' button
 +
# Select '''Training &gt; Demonstration &gt; Harry Hornbill – The Bird, The Legend'''
 +
# Click '''Apply'''
 +
# Set Site Target to '''Server''' and select an ''Instance''
 +
# Set Target Device to Inventory and select a ''Device''
 +
# Set Admin Credentials to '''Network Admin'''
 +
# Click '''Create'''
 +
 +
=== Monitor ===
 +
 +
<blockquote>[[File:media/image17.png|356x244px]]
 +
</blockquote>
 +
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 ==
 +
 +
# Navigate to ('''''Home &gt; ITOM &gt;'' Job Queue''')
 +
# Click the '''Create New''' button, and select '''IT Automation'''
 +
# Enter Name: '''Harry Hornbill on Multiple Computers'''
 +
# Click the '''Installed Packages''' button
 +
# Select '''Training &gt; Demonstration &gt; Harry Hornbill – The Bird, The Legend'''
 +
# Click '''Apply'''
 +
# Set Site Target to '''Server''' and select an ''Instance''
 +
# Set Target Device to '''Inventory''' and select a ''Device''
 +
# Set Admin Credentials to '''Network Admin'''
 +
# Click '''Create'''
 +
 +
<blockquote>[[File:media/image18.png|399x289px]]
 +
</blockquote>
 +
<ol start="11" style="list-style-type: decimal;">
 +
<li><p>Click on a Job '''Name''' to view the Individual Child Job</p></li>
 +
<li><p>Click Parent Link in the Summary to Return to Parent Job</p></li></ol>
 +
 +
<blockquote>[[File:media/image19.png|302x109px]]
 +
</blockquote>
 +
= Job Scheduling =
 +
 +
== Discovery ==
 +
 +
# Navigate to ('''''Home &gt; ITOM &gt;'' Job Scheduling''')
 +
# Click the '''Create New''' button, and Select '''Discovery Schedule'''
 +
# 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'''
 +
# Ensure '''Next Scheduled Date and Time''' is set to a couple of minutes in the future
 +
# Click '''Enable Schedule'''
 +
# '''Navigate to (''Home &gt; ITOM &gt;'' Job Scheduling)'''
 +
 +
[[File:media/image20.png|490x87px]]
 +
 +
<ol start="7" style="list-style-type: decimal;">
 +
<li><p>Wait for the Job schedule Time, and Click on the ''AD Discovery'' Job '''Name'''</p></li>
 +
<li><p>Click the '''Job History'''</p></li>
 +
<li><p>Click on the ''Scheduled AD Discover'' '''Name'''</p></li></ol>
 +
 +
== IT Automation ==
 +
 +
# Navigate to ('''''Home &gt; ITOM &gt;'' Job Scheduling''')
 +
# Click the '''Create New''' button, and Select '''IT Automation Schedule'''
 +
# Enter the following Schedule details:
 +
#* Name: '''Windows''' '''Disk Cleanup'''
 +
#* Schedule: '''Run daily'''
 +
# Ent the following IT Automation Job Settings:
 +
#* Package: '''private:hornbill &gt; Disk Cleanup &gt;''' '''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''':
 +
 +
<blockquote>'''InternetCacheFiles''', '''Recycle Bin''', and '''Temporary Files'''
 +
</blockquote>
 +
<ol start="5" style="list-style-type: decimal;">
 +
<li><p>Ensure '''Next Scheduled Date and Time''' is set to a couple of minutes in the future</p></li>
 +
<li><p>Click '''Enable Schedule'''</p></li>
 +
<li><p>'''Navigate to (''Home &gt; ITOM &gt;'' Job Scheduling)'''</p></li>
 +
<li><p>Wait for the Job schedule Time, and Click on the Job Name''': Windows Disk Cleanup'''</p></li>
 +
<li><p>Click '''Job History'''</p></li></ol>
 +
 +
<blockquote>[[File:media/image21.png|484x184px]]
 +
</blockquote>
 +
<ol start="10" style="list-style-type: decimal;">
 +
<li><p>Click on the Job Name''': Windows Disk Cleanup''' (with the highest Job Id)</p></li></ol>
 +
 +
[[File:media/image22.png|464x219px]]
 +
 +
<ol start="11" style="list-style-type: decimal;">
 +
<li><p>Review the list of jobs, and confirm that all are successful</p></li>
 +
<li><p>Click on the Name of any Job entry in the list and review the Details</p></li>
 +
<li><p>To return to the parent Click the link shown in the '''Summary''' section</p></li></ol>
 +
 +
= Runbooks =
 +
 +
== Create a Runbook Process ==
 +
 +
# [[File:media/image1.png|21x20px]]From the ITOM page, select '''Runbooks'''
 +
# Click the button
 +
# Enter a '''Name'''
 +
 +
[[File:media/image23.png|450x182px]]
 +
 +
=== Build a Runbook Process ===
 +
 +
# Select the connection line between the '''Start''' and '''End''' nodes
 +
# Right click on the selected line and select “'''Add node between connected nodes'''”
 +
 +
[[File:media/image24.png|183x166px]]
 +
 +
<ol start="3" style="list-style-type: decimal;">
 +
<li><p>Select '''IT Automation'''</p></li></ol>
 +
 +
[[File:media/image25.png|17x16px]][[File:media/image26.png|201x140px]]
 +
 +
<ol start="4" style="list-style-type: decimal;">
 +
<li><p>Hover over the '''IT Automation''' node, and click on the '''Settings''' icon</p></li></ol>
 +
 +
[[File:media/image27.png|414x142px]]
 +
 +
<ol start="5" style="list-style-type: decimal;">
 +
<li><p>Enter '''Run Harry''' as the Display name</p></li></ol>
 +
 +
[[File:media/image27.png|397x156px]]
 +
 +
<ol start="6" style="list-style-type: decimal;">
 +
<li><p>Click the '''Add Package''' button</p></li></ol>
 +
 +
<blockquote>[[File:media/image28.png|273x142px]]
 +
</blockquote>
 +
<ol start="7" style="list-style-type: decimal;">
 +
<li><p>Select '''Harry Hornbill'''</p></li>
 +
<li><p>Confirm the Run Operation is set to '''Show Harry'''</p></li>
 +
<li><p>Set Target Machine type to '''Machine''', and select a Computer</p></li>
 +
<li><p>[[File:media/image29.png|26x23px]]Click '''Save draft''' button</p></li></ol>
 +
 +
=== [[File:media/image30.png|30x25px]]Publish a Runbook Process ===
 +
 +
# Click the '''Publishing Manager''' button
 +
 +
[[File:media/image31.png|385x84px]]
 +
 +
===  ===
 +
 +
===  ===
 +
 +
===  ===
 +
 +
<ol start="2" style="list-style-type: decimal;">
 +
<li><p>Click the '''Publish''' button</p></li>
 +
<li><p>Click '''Runbooks''' from the breadcrumbs at the top of the page</p></li></ol>
 +
 +
=== Manually Execute a Runbook Process ===
 +
 +
# Locate the Runbook Entry on the Runbooks list
 +
# [[File:media/image32.png|17x17px]]Click the '''Invoke''' action button
 +
# Click '''Invoke'''
 +
 +
=== Schedule a Runbook Process ===
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><p>Navigate to ('''''Home &gt; ITOM &gt;'' Job Scheduling''')</p></li>
 +
<li><p>Click the '''Create New''' button, and Select '''Runbook Schedule'''</p></li>
 +
<li><p>Enter the following Schedule details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Name: '''Harry Hornbill'''</p></li>
 +
<li><p>Schedule: '''Run Once'''</p></li>
 +
<li><p>Runbook: '''Run Harry'''</p></li>
 +
<li><p>Set the following Operation Parameters to '''True''':</p></li></ol>
 +
</li>
 +
<li><p>Click '''Enable Schedule'''</p></li>
 +
<li><p>'''Navigate to (''Home &gt; ITOM &gt;'' Job Scheduling)'''</p></li>
 +
<li><p>Wait for the Job schedule Time, and Click on the Job Name''': Harry Hornbill'''</p></li>
 +
<li><p>Click '''Job History'''</p></li>
 +
<li><p>Confirm the Status of the Job</p></li></ol>
 +
 +
= Service Manager Interaction  =
 +
 +
== Hornbill Business Process Manager ==
 +
 +
== Runbook Process ==
 +
 +
# Navigate to ('''''[https://betaadmin.hornbill.com/rickyf/ Home] &gt;  [https://betaadmin.hornbill.com/rickyf/app/ Applications] &gt; [https://betaadmin.hornbill.com/rickyf/app/com.hornbill.servicemanager/ Hornbill Service Manager] &gt; Business Processes''''')
 +
# Locate '''EXAMPLE Hornbill Incident Process''' and click the '''Copy Process''' action button
 +
# Enter the name '''Demo Business Process''', and click '''Apply'''
 +
# Select the Connector between the '''Start''' and '''Set Status to New''' nodes
 +
# Right Click and Select '''Runbook Process'''
 +
# Double click on the new node
 +
# Select '''Run Harry''' from the Runbook drop down
 +
# Click Save
 +
# Publish the Business Process ** Needs work ***
 +
# Assign the new process to an Incident ** Needs work ***
 +
# Raise an Incident
 +
 +
== IT Automation ==
 +
 +
# Navigate to ('''''[https://betaadmin.hornbill.com/rickyf/ Home] &gt;  [https://betaadmin.hornbill.com/rickyf/app/ Applications] &gt; [https://betaadmin.hornbill.com/rickyf/app/com.hornbill.servicemanager/ Hornbill Service Manager] &gt; Business Processes''''')
 +
# Locate '''Demo Business Process''' and click the link under Workflow
 +
# Right Click the '''Runbook Process''' node, and select '''Delete'''
 +
# Add a new node by dragging the '''Arrow''' underneath the '''Start''' node to a blank area and releasing
 +
# Select '''IT''' '''Automation'''
 +
# Double click on the new node
 +
# Select Run Package as '''Demonstration &gt; Harry Hornbill ...'''
 +
# Click '''Apply'''
 +
# Set Target Machine type to '''Machine''', and select a Computer
 +
# Connect the New '''IT Automation''' node to the '''Set status to New''' node
 +
# Click '''Save'''
 +
# Publish the Business Process ** Needs work ***
 +
# Raise an Incident
 +
 +
= Package Creator =
 +
 +
== Create a Simple Package ==
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><p>[[File:media/image1.png|23x22px]]From the ITOM page select Package Creator</p></li>
 +
<li><p>Click button</p></li>
 +
<li><p>Enter a Package name: '''TCP Utilities'''</p></li>
 +
<li><p>Set Target OS to '''Windows Universal'''</p></li>
 +
<li><p>Click '''Add Operation''' button</p></li>
 +
<li><p>Enter the following details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Operation: '''Ping'''</p></li>
 +
<li><p>Description: '''Ping a device using the parameters -n, host'''</p></li>
 +
<li><p>'''Command Type: Run Command'''</p></li>
 +
<li><p>'''Command: cmd /c ping.exe'''</p></li>
 +
<li><p>'''Timeout(secs): 60'''</p></li>
 +
<li><p>'''Options/Args: -n {param.count} {param.host}'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Add Parameter button'''</p></li>
 +
<li><p>'''Set the following attributes:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Required'''</p></li>
 +
<li><p>'''Number'''</p></li>
 +
<li><p>'''Parameter Name: count'''</p></li>
 +
<li><p>'''Default value: 3'''</p></li>
 +
<li><p>'''Hint: Number of echo requests to send.'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Add Parameter button'''</p></li>
 +
<li><p>'''Set the following attributes:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Required'''</p></li>
 +
<li><p>'''string'''</p></li>
 +
<li><p>'''Parameter Name: host'''</p></li>
 +
<li><p>'''Hint: Target device hostname.'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Apply'''</p></li>
 +
<li><p>'''Click Baseline button'''</p></li>
 +
<li><p>'''Select Version 1 via the Drop Down Adjacent to the Baseline button'''</p></li>
 +
<li><p>'''Click Package and Install drop down, and select Package and Install'''</p></li>
 +
<li><p>'''Navigate to (Home &gt; ITOM &gt; Job Queue)'''</p></li>
 +
<li><p>'''Click Create New button, and select IT Automation Job'''</p></li>
 +
<li><p>'''Select Run Package: private:{''instance-name''} &gt; General Purpose &gt; TCP Utilities (Version 1)'''</p></li>
 +
<li><p>'''Click Apply'''</p></li>
 +
<li><p>'''Enter the following details:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Name: Ping Computer'''</p></li>
 +
<li><p>'''Run Operation: ping'''</p></li>
 +
<li><p>'''Site Target: Server | &lt;SIS Server&gt;'''</p></li>
 +
<li><p>'''Target Machine: Inventory |&lt;target computer&gt;'''</p></li>
 +
<li><p>'''Admin Credentials'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Create'''</p></li></ol>
 +
 +
== Windows Installer Package ==
 +
 +
# [[File:media/image1.png|23x22px]]From the ITOM page select Package Creator
 +
# Click button
 +
# Enter a Package name: '''Software Installer'''
 +
# [[File:media/image33.png|25x20px]]Set Target OS to '''Windows Universal'''
 +
# Click '''Upload File''' button
 +
# Select the following file:
 +
 +
<blockquote>'''C:\ Documents\ITOM\Packages\Demo.msi'''
 +
</blockquote>
 +
<ol start="7" style="list-style-type: decimal;">
 +
<li><p>Click on '''Package Info'''</p></li>
 +
<li><p>Click '''Add Operation''' button</p></li>
 +
<li><p>Enter the following details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Operation: '''Install'''</p></li>
 +
<li><p>Description: '''Install Windows application'''</p></li>
 +
<li><p>'''Command Type: Windows Installer'''</p></li>
 +
<li><p>'''Package: Demo.msi'''</p></li>
 +
<li><p>'''Action: Install Software'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Add'''</p></li>
 +
<li><p>Click '''Add Operation''' button</p></li>
 +
<li><p>Enter the following details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Operation: '''Uninstall'''</p></li>
 +
<li><p>Description: '''Uninstall Windows application'''</p></li>
 +
<li><p>'''Command Type: Windows Installer'''</p></li>
 +
<li><p>'''Package: Demo.msi'''</p></li>
 +
<li><p>'''Action: Uninstall Software'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Add'''</p></li>
 +
<li><p>'''Click Baseline button'''</p></li>
 +
<li><p>'''Select Version 1 via the Drop Down Adjacent to the Baseline button'''</p></li>
 +
<li><p>'''Click Package and Install drop down, and select Package and Install'''</p></li></ol>
 +
 +
=== Execute Installation Job  ===
 +
 +
# '''Navigate to (Home &gt; ITOM &gt; Job Queue)'''
 +
# '''Click Create New button, and select IT Automation Job'''
 +
# '''Select Package:'''
 +
 +
<blockquote>'''private:{''instance-name''} &gt; General Purpose &gt; Software Installer (Version 1)'''
 +
</blockquote>
 +
<ol start="4" style="list-style-type: decimal;">
 +
<li><p>'''Click Apply'''</p></li>
 +
<li><p>'''Enter the following details:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Name: Software Installation'''</p></li>
 +
<li><p>'''Run Operation: Install'''</p></li>
 +
<li><p>'''Site Target: Server | &lt;SIS Server&gt;'''</p></li>
 +
<li><p>'''Target Machine: Inventory |&lt;target computer&gt;'''</p></li>
 +
<li><p>'''Admin Credentials: &lt;relevant KeySafe entry&gt;'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Create'''</p></li>
 +
<li><p>'''Verify that the following software exists on the target:'''</p></li></ol>
 +
 +
<blockquote>'''Name: Generic Business Application'''
 +
 +
'''Publisher: Acme Software Ltd'''
 +
</blockquote>
 +
=== Execute Uninstallation Job  ===
 +
 +
# '''Navigate to (Home &gt; ITOM &gt; Job Queue)'''
 +
# '''Click Create New button, and select IT Automation Job'''
 +
# '''Select Package:'''
 +
 +
<blockquote>'''private:{''instance-name''} &gt; General Purpose &gt; Software Installer (Version 1)'''
 +
</blockquote>
 +
<ol start="4" style="list-style-type: decimal;">
 +
<li><p>'''Click Apply'''</p></li>
 +
<li><p>'''Enter the following details:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Name: Software Uninstallation'''</p></li>
 +
<li><p>'''Run Operation:UniInstall'''</p></li>
 +
<li><p>'''Site Target: Server | &lt;SIS Server&gt;'''</p></li>
 +
<li><p>'''Target Machine: Inventory |&lt;target computer&gt;'''</p></li>
 +
<li><p>'''Admin Credentials: &lt;relevant KeySafe entry&gt;'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Create'''</p></li>
 +
<li><p>'''Verify that the following the software no longer exists on the target:'''</p></li></ol>
 +
 +
<blockquote>'''Name: Generic Business Application'''
 +
 +
'''Publisher: Acme Software Ltd'''
 +
</blockquote>
 +
== Windows Executable ==
 +
 +
# [[File:media/image1.png|23x22px]]From the ITOM page select Package Creator
 +
# Click button
 +
# Enter a Package name: '''Windows Executable'''
 +
# Set Target OS to '''Windows Universal'''
 +
# Click '''Upload File''' button
 +
# Select the following file:
 +
 +
<blockquote>'''C:\ Documents\ITOM\Packages\ShowHarry.exe'''
 +
</blockquote>
 +
<ol start="7" style="list-style-type: decimal;">
 +
<li><p>Click on '''Package Info'''</p></li>
 +
<li><p>Click '''Add Operation''' button</p></li>
 +
<li><p>Enter the following details:</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>Operation: '''Show Harry'''</p></li>
 +
<li><p>Description: '''Windows Executable - Show Harry.exe'''</p></li>
 +
<li><p>'''Command Type: Windows Executable'''</p></li>
 +
<li><p>'''Run File: ShowHarry.exe'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Add'''</p></li>
 +
<li><p>'''Click Baseline button'''</p></li>
 +
<li><p>'''Select Version 1 via the Drop Down Adjacent to the Baseline button'''</p></li>
 +
<li><p>'''Click Package and Install drop down, and select Package and Install'''</p></li></ol>
 +
 +
=== Execute Windows Executable Job  ===
 +
 +
<ol style="list-style-type: decimal;">
 +
<li><p>'''Navigate to (Home &gt; ITOM &gt; Job Queue)'''</p></li>
 +
<li><p>'''Click Create New button, and select IT Automation Job'''</p></li>
 +
<li><p>'''Select Run Package: private:{''instance-name''} &gt; General Purpose &gt; Windows Executable (Version 1)'''</p></li>
 +
<li><p>'''Click Apply'''</p></li>
 +
<li><p>'''Enter the following details:'''</p>
 +
<ol style="list-style-type: lower-alpha;">
 +
<li><p>'''Name: Windows Executable'''</p></li>
 +
<li><p>'''Run Operation: Show Harry'''</p></li>
 +
<li><p>'''Site Target: Server | &lt;SIS Server&gt;'''</p></li>
 +
<li><p>'''Target Machine: Inventory |&lt;target computer&gt;'''</p></li>
 +
<li><p>'''Admin Credentials'''</p></li></ol>
 +
</li>
 +
<li><p>'''Click Create'''</p></li></ol>
 +
 +
== Batch Script ==
 +
 +
== PowerShell Script ==
 +
 +
= Trouble Shooting =
 +
 +
= Site Integration Server =
 +
 +
== Rename server ==
 +
 +
== <br />
 +
==
 +
 +
= Appendix A =
 +
 +
Required User Rights
 +
 +
Add these two rights to be able to Run AS
 +
 +
Missing privilege: Replace a process-level token. (SeAssignPrimaryTokenPrivilege)<br />
 +
Missing privilege: Act as part of the operating system. (SeTcbPrivilege)
 +
 +
[[File:media/image34.png|601x180px]]
 +
 +
[[File:media/image35.png|601x73px]]

Revision as of 10:21, 23 April 2020

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 Image: 500 pixels 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

  4. Click the Create Site Integration Service button

Image: 350 pixels

  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

328x200px

  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

411x141px

SIS Server Pairing

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

252x162px

  1. Enter the instance ID

  2. Enter the Authorization Code recorded earlier

  3. Click the Pair with Instance

479x297px

Creating admin credentials in Keysafe

  1. From the Hornbill Administration page Select System > Security > KeySafe
  2. Click the Image: 500 pixelsbutton
  3. Select Type as Username + Password

269x187px

  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

468x255px

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 40x36px

341x134px

  1. Select All Discovered Devices

40x36px324x156px

  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

175x64px

  1. Select the Test Servers list and Click Apply button

Installed Packages

Navigate to (Home > ITOM > Installed Packages)

42x33pxPackage Library

  1. Click the Package Library button

497x150px

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

  2. Click Install on Windows Disk Cleanup

  3. Click Close

43x32pxUploading 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

433x207px

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

356x244px

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

399x289px

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

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

302x109px

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)

490x87px

  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

484x184px

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

464x219px

  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. 21x20pxFrom the ITOM page, select Runbooks
  2. Click the button
  3. Enter a Name

450x182px

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

183x166px

  1. Select IT Automation

17x16px201x140px

  1. Hover over the IT Automation node, and click on the Settings icon

414x142px

  1. Enter Run Harry as the Display name

397x156px

  1. Click the Add Package button

273x142px

  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. 26x23pxClick Save draft button

30x25pxPublish a Runbook Process

  1. Click the Publishing Manager button

385x84px

  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. 17x17pxClick 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 >  Applications > Hornbill Service Manager > 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 >  Applications > Hornbill Service Manager > 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. 23x22pxFrom 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

  20. Click Create

Windows Installer Package

  1. 23x22pxFrom the ITOM page select Package Creator
  2. Click button
  3. Enter a Package name: Software Installer
  4. 25x20pxSet 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: Uninstall 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>

  3. Click Create

  4. 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>

  3. Click Create

  4. Verify that the following the software no longer exists on the target:

Name: Generic Business Application

Publisher: Acme Software Ltd

Windows Executable

  1. 23x22pxFrom 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

  6. 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)

601x180px

601x73px