Difference between revisions of "ITOM Package Creator Quick Guide"

From Hornbill
Jump to navigation Jump to search
Line 12: Line 12:
 
= Package Creator =
 
= Package Creator =
  
−
== Create a Simple Package ==
+
Packages contain a number of operations that provide some functionality to be used within an IT Automation.  In general, the operations contained within a package would relate in some form, i.e AD user management (Create, Delete, Disable, Enable, etc.).  However, it is completely up to yourself what operations are contained within a package.  You could, for example, have a package called toolbox, which contains operations for User Management, TCP/IP Utilities, File Management etc.  This would no doubt become a little confusing and difficult to manage in the long term.
  
−
<ol style="list-style-type: decimal;">
+
Package operation types:
−
<li><p>From the ITOM page select Package Creator</p></li>
+
:{|
−
<li><p>Click the New Pacakge button [[File:NewPackageButton.png|23x22px]]</p></li>
+
|- valign="top"
−
<li><p>Enter a Package name: '''TCP Utilities'''</p></li>
+
|style="width:300px"|
−
<li><p>Set Target OS to '''Windows Universal'''</p></li>
+
* Run an OS Command
−
<li><p>Click '''Add Operation''' button</p></li>
+
* Run a Windows Installer
−
<li><p>Enter the following details:</p>
+
* Run a Windows Executable
−
<ol style="list-style-type: lower-alpha;">
+
* Batch Script
−
<li><p>Operation: '''Ping'''</p></li>
+
|style="width:300px"|
−
<li><p>Description: '''Ping a device using the parameters -n, host'''</p></li>
+
* Windows Powershell
−
<li><p>Command Type: '''Run Command'''</p></li>
+
* Powershell Core
−
<li><p>Command: '''cmd /c ping.exe'''</p></li>
+
* Linux Shell Script
−
<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: '''Network Admin'''</p></li></ol>
 
−
</li>
 
−
<li><p>Click '''Create'''</p></li></ol>
 
−
 
 
−
== Windows Installer Package ==
 
−
 
 
−
# From the ITOM page select Package Creator
 
−
# Click the '''New Package''' [[File:NewPackageButton.png|23x22px]] button
 
−
# Enter a Package name: '''Software Installer'''
 
−
# Set Target OS to '''Windows Universal'''
 
−
# Click '''Upload File''' [[File:PacakgeUploadButton.png|25x20px]] 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: ''''Network Admin'''</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: '''Network Admin'''</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 ==
 
−
 
 
−
# From the ITOM page select Package Creator
 
−
# Click the New Package [[File:NewPackageButton.png|23x22px]] 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 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: '''Network Admin'''</p></li></ol>
 
−
</li>
 
−
<li><p>'''Click Create'''</p></li></ol>
 
−
 
 
−
== CMD Script ==
 
−
 
 
−
TBC
 
−
 
 
−
== PowerShell Script ==
 
−
TBC
 

Revision as of 13:03, 17 July 2020

Home > Administration > ITOM > Quick Start Guide Index

Introduction

Hornbill ITOM provides you with the ability to create your own user-defined packages, of which you can use to create IT Automations and enhance Runbooks processes. This guide will take you through the basics of creating the different types of packages that are available, publishing and executing them. Packages can be as simple operation such as executing an OS command or executable thru to the creation of a complex script.

Information
Although no technical skills will be required to follow this guide, further knowledge will in the relevant areas be required in order to use these features successfully.
Related Articles

Package Creator

Packages contain a number of operations that provide some functionality to be used within an IT Automation. In general, the operations contained within a package would relate in some form, i.e AD user management (Create, Delete, Disable, Enable, etc.). However, it is completely up to yourself what operations are contained within a package. You could, for example, have a package called toolbox, which contains operations for User Management, TCP/IP Utilities, File Management etc. This would no doubt become a little confusing and difficult to manage in the long term.

Package operation types:

  • Run an OS Command
  • Run a Windows Installer
  • Run a Windows Executable
  • Batch Script
  • Windows Powershell
  • Powershell Core
  • Linux Shell Script
Retrieved from "https://wiki.hornbill.com/index.php?title=ITOM_Package_Creator_Quick_Guide&oldid=24673"