Difference between revisions of "IT Automation Job"

Latest revision as of 11:24, 14 December 2020

Home > ITOM > Job Queue > Create New Job > IT Automation Job

Introduction

IT Automation jobs are executed on Managed Devices selected from within the ITOM Inventory and can be initiated from various sources such as a Hornbill Business Process or AutoTask. Jobs can be executed on an ad-hoc basis as well as scheduled, or via a Runbook process, all configured via the Hornbill Administration portal. Packages are used to provide the automation payload and may require prerequisites to be in place along with security credentials. This information and details of all configurable parameters are provided via the Package documentation found in the ITOM Package Library.

Creating an IT Automation Job

Select the Create New option
Select IT Automation Job
Enter Name to identify the Job
Select the required Pacakage via the button
Select the Run Operation
Select a Site Target (SIS)
This can be a single Server or a Group
Select the required Target Machine
This can be from a previously created List, the Discovered Inventory list or Manually entered
Enter the relevant Credentials as required
The selected Run Operation determines this
Enter any necessary parameters
The selected Run Operation determines this
Click Create button

Job Properties

Name

Name provided to identify the IT Automation Job

Package

Package used to provide the IT Automation payload

Run Operation

Operation to perform using the package

Site Target

Specify the SIS Server or Group that will facilitate the Automation Job

Target Device

Select the Device(s) that the Operation will target

List

Target Devivces are sourced from a pre-created Inventory List

Inventory

Select a Device from the ITOM Inventory

Manual

Manually entered device name, that must already exist in the ITOM Inventory and is marked as a Managed device

Credentials

Sourced from the KeySafe, provides the security context to be used for package deployment and execution

Admin Credentials

Security Context used to deploy the package onto the target device(s)

Run As Credentials

Security Context used to execute the package on the target device(s) (if not provided then Admin Credentials are used)

Extra Credentials

Optional credentials used as part of the functionality within the package

Operation Parameters

Once a package and a Run Operation has been selected, any related parameters will be displayed; mandatory fields are highlighted and hints may be provided in the input box.

Job Details

Once the job has been created, details will be displayed showing information relating to the job, including the status of the job. Monitoring, Console and Debug Logging are provided for displaying a jobs progress and to aid with troubleshooting failures.

Summary

Shows the current status of the job and its name along with who created it and when

Package Details

Displays details of the deployment package, configured operation along with any arguments that were specified and job timeout limit

Target Information

Provides details of the SIS server that will facilitate the job, target machine and the security keys used

Execution Details

The execution details show when the job was started and completed along with any result code

Monitor

The Monitor frame provides information relating to the execution of the job; the details shown will be dependant on the type of discovery or package that is being been executed.

The above example shows that the process has started and provides an id, which can be used to identify the task executing the package on the target machine. Depending on the package configuration, the monitor will specify more than the process ID. In the above case, the package is configured to execute an executable program as a specific user, using the "Run As Credentials". The first ID is for the process that triggers the package execution, which triggers another process to run an executable using the provided credentials.

Console Output

All console output from the process will be displayed after this and will dependant on the package contents and configuration. Once the job has completed if there are any output parameters, they are processed and displayed, and confirmation of the job successful completion or failure will be output.

Once the job has completed the Console Output and Debug Log frames will become enabled. The Console Output provides a view of only the console output, including any error messages.

Debug Log

In cases where the Package may have failed or completed incorrectly, the Debug Log can be used to review errors and other technical information.

The Log provides three sections:

Full

Full debug log information

Standard

Information log entries

Problem

Warning and Error, entries that may identify potential problems

The sections output will depend on the job, and thus some sections may not be available

Action Buttons

Activate this Job

Enables a Deferred Job to be Activated for processing

Copy this Job

Copies the job's properties and allows for a new job to be created once edited

Cancel

When a job is cancelled its process will be sent a close message, therefore, allowing the process to close itself and all child processes in an orderly fashion

Abort

Aborting a Job causes the Job to be forcefully terminated immediately possibly causing child processes to be orphaned, and should only be used as a last resort

@@ Line 1: / Line 1: @@
-{{Bluebanner|[[Main Page|Home]] > [[IT Operations Management|ITOM]] > [[Job Queue]] > Create New|[[:Category:ITOM|Index]]}}
+{{Bluebanner|[[Main Page|Home]] > [[IT Operations Management|ITOM]] > [[Job Queue]] > [[Create New Job]] > IT Automation Job|[[:Category:ITOM|Index]]}}
 {|style="width: 100%"
 |- valign="top"
 |style="width:73%"|
 ==Introduction==
-IT Automation jobs are executed on Managed Devices from within the ITOM Inventory, on a ad-hoc basis. These Jobs can be executed on individual devices or a list of devices from pre-configured Inventory Lists.  Published and uploaded packages are used to provide the automation payload which are managed via the [[ITOM Package Library]]. Depending on the package used Credentials and Package Parameters will need to be configured, these details will be provided via the Package documentation.
+IT Automation jobs are executed on Managed Devices selected from within the ITOM Inventory and can be initiated from various sources such as a Hornbill Business Process or AutoTask.  Jobs can be executed on an ad-hoc basis as well as scheduled, or via a Runbook process, all configured via the Hornbill Administration portal. Packages are used to provide the automation payload and may require prerequisites to be in place along with security credentials.  This information and details of all configurable parameters are provided via the Package documentation found in the [[ITOM Package Library]].
 |style="width:5%"|
 |
@@ Line 11: / Line 11: @@
 == Related Articles ==
 * [[IT Operations Management]]
-* [[Create New Job]]
 * [[ITOM Package Library]]
 * [[Site Integration Services]]
@@ Line 17: / Line 16: @@
 |}
-==IT Automation Job Properties==
+== Creating an IT Automation Job==
-[[File:JobQueueAutomationJobPkg.png|right|350px|link=https://wiki.hornbill.com/images/2/28/JobQueueAutomationJobPkg.png|ITOM IT Automation Job Properties]]
+# Select the '''Create New''' option
-* Name - the name provided to identify the IT Automation Job
+# Select '''IT Automation Job'''
-* Package - the package in which the operation is stored
+# Enter Name to identify the Job
-*:[[File:JobQueueAutoJobPackageList.png|250px]]
+# Select the required Pacakage via the [[File:SelectPackageButton.png|30x30px]] button
-* Run Operation - which operation to perform using the package
+# Select the Run Operation
-* Site Target [Group / Server ] - whether the Job needs to run on all the machines in the SIS Group or on a single SIS/Managed CI
+# Select a Site Target (SIS)
-* Target Machine [List / Inventory / Manual] -
+#:This can be a single Server or a Group
-* Credentials
+# Select the required Target Machine
-** Admin Credentials - Keystore entry
+#:This can be from a previously created List, the Discovered Inventory list or Manually entered
-** Run As Credentials - Keystore entry
+# Enter the relevant Credentials as required
-* Extra Credentials - one is able to add other credentials which might be used as part of the functionality within the package
+#:The selected Run Operation determines this
-* Package Parameters - INPUT parameters of the selected package; mandatory fields are highlighted; hints might be given in the field box.
+# Enter any necessary parameters
+#:The selected Run Operation determines this
+# Click Create button
-== Job Information ==
+[[Category:ITOM]]
-Once the job has been created, the details will be displayed, showing information relating to the job, from here it is also able to view the status of the job and monitor its progress within the Monitor frame.
-* Summary
+==Job Properties==
-*: Shows the current status of the job and its name along with who created it and when.
+{{Bullet1|Name|Name provided to identify the IT Automation Job}}
-* Target Information
+{{Template:IT Automation Job Properties}}
-*: Provides details of the SIS server that will facilitate the job, target machine and the security keys used.
-S server where the is executed
+== Job Details ==
-* Execution Details
+[[File:JobQueueAutomationJobDetailsFade.png|350px|right|link=https://wiki.hornbill.com/images/b/b2/JobQueueAutomationJobDetails.png|ITOM IT Automation Job Properties]]
-*: The execution details show when the job was started and completed along with any result code.
+Once the job has been created, details will be displayed showing information relating to the job, including the status of the job.  Monitoring, Console and Debug Logging are provided for displaying a jobs progress and to aid with troubleshooting failures.
-Dependent on which type of job was executed there will be:
+{{Bullet1|Summary|Shows the current status of the job and its name along with who created it and when}}
-* Package Details (IT Automation)
+{{Bullet1|Package Details|Displays details of the deployment package, configured operation along with any arguments that were specified and job timeout limit}}
-*: Displays details of the deployment package, configured operation along with any arguments that were specified and job timeout limit.
+{{Bullet1|Target Information|Provides details of the SIS server that will facilitate the job, target machine and the security keys used}}
-or:
+{{Bullet1|Execution Details|The execution details show when the job was started and completed along with any result code}}
-* Discovery Options (Discovery)
-*: Displays details of the options used by the discovery process, this will differ depending on the discovery mode that is being used.
 [[Category:ITOM]]
-=== Monitor ===
+===Monitor===
-The Monitor frame provides information relating to the execution of the job, the details shown will be dependant on the type of discovery or package that is being been executed.
+The Monitor frame provides information relating to the execution of the job; the details shown will be dependant on the type of discovery or package that is being been executed.
 [[image:jobMonitorWhoAmI-Identity.png]]
@@ Line 57: / Line 54: @@
 The above example shows that the process has started and provides an id, which can be used to identify the task executing the package on the target machine. Depending on the package configuration, the monitor will specify more than the process ID.  In the above case, the package is configured to execute an executable program as a specific user, using the "Run As Credentials".  The first ID is for the process that triggers the package execution, which triggers another process to run an executable using the provided credentials.
-All console output from the process will be displayed after this and will dependant on the package contents and configuration. Once the job has completed if there are any output parameters they are processed and displayed, and confirmation of the job successful completion or failure will be output.
+===Console Output===
+All console output from the process will be displayed after this and will dependant on the package contents and configuration. Once the job has completed if there are any output parameters, they are processed and displayed, and confirmation of the job successful completion or failure will be output.
 Once the job has completed the Console Output and Debug Log frames will become enabled.  The Console Output provides a view of only the console output, including any error messages.
@@ Line 63: / Line 61: @@
 [[image:jobConsoleWhoAmI-Identity.png]]
-In cases where the package may have failed any error messages that are displayed to the console will be visible here, however, this is may not always be the case and is dependant on the package.  In these cases and where further details are required the Debug Log can be used to review more technical details.
+===Debug Log===
+In cases where the Package may have failed or completed incorrectly, the Debug Log can be used to review errors and other technical information.
 [[image:jobDebugLogWhoAmI-Identity.png]]
-The Debug Log frame provides two levels of output "Standard" and "Full".  Standard logging provides basic output such as the package details, argument, and command details.  Full logging provides further details such as the location of log files, the target computer, encoded parameters, and credentials.  The exact content will depend on the package being deployed and its configuration.
+The Log provides three sections:
+{{Bullet1|Full|Full debug log information}}
+{{Bullet1|Standard|Information log entries}}
+{{Bullet1|Problem|Warning and Error, entries that may identify potential problems}}
-===Cancel / Aborting this Job===
+{{infobox|The sections output will depend on the job, and thus some sections may not be available}}
-Where it is required for a Job to be Cancelled, for example; maybe the job has stalled or is taking a large amount of time and resources. Two options are available via the Cancel and Abort buttons, although their purpose of the two is to kill a process running on a target computer, their methods are different. In most cases just Cancelling a job should suffice, however in cases where this option fails, Abort can be used to force the termination of the Job.
-When a job is cancelled its process will be sent a close message, therefore, allowing the process to close itself and all child processes in an orderly fashion. Aborting a Job causes the Job to be forcefully terminated immediately possibly causing child processes to be orphaned, and should only be used as a last resort.
+===Action Buttons===
+{{Bullet1|Activate this Job|Enables a Deferred Job to be Activated for processing}}
+{{Bullet1|Copy this Job|Copies the job's properties and allows for a new job to be created once edited}}
+{{Bullet1|Cancel|When a job is cancelled its process will be sent a close message, therefore, allowing the process to close itself and all child processes in an orderly fashion}}
+{{Bullet1|Abort|Aborting a Job causes the Job to be forcefully terminated immediately possibly causing child processes to be orphaned, and should only be used as a last resort}}