Difference between revisions of "Discovery Job"

From Hornbill
Jump to navigation Jump to search
 
(23 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
|style="width:73%"|
 
|style="width:73%"|
 
==Introduction==
 
==Introduction==
−
A Discovery is executed from a designated SIS server using Admin Credentials provided via the Hornbill KeySafe, using one of the various methods provided.  Once all the devices have been discovered, dependant on configuration, a ping request will also be sent to each device. The Admin Credentials are further used for access to each devices Inventory (e.g. hardware, operating system, installed programs) using WMI via DCOM or WinRM.  On successful completion, the device details will be stored within the ITOM Inventory and can be identified as managed and the Inventory viewed.
+
A Discovery is executed from a designated SIS server, using one of the various methods provided.  Once discovered, dependant on configuration, an optional ping request will also be sent to each device. Admin Credentials provided via the Hornbill KeySafe, used for access to the inventory of each device (e.g. hardware, operating system, installed programs) using WMI via DCOM, WinRM or SSH.  For Unix / Linux devices Admin Credentials are used to access the inventory of each device using SSH.  On successful completion, discovered device details are accessible within the ITOM Inventory.
 
|style="width:5%"|
 
|style="width:5%"|
 
|
 
|
Line 15: Line 15:
 
|}
 
|}
  
−
==Discovery Job Properties ==
+
== Creating a Discovery==
−
[[File:ITOMAddDiscovery.png|right|350px|link=https://wiki.hornbill.com/images/2/28/ITOMAddDiscovery.png|ITOM Add Discovery Job]]
+
# Open the Hornbill Administration Tool
−
{{Bullet1|Name|Name given to identify this Discovery Job}}
+
# Navigate to '''Home > ITOM > Job Queue'''
−
{{Bullet1|Site Target [Group / Server ]|whether the job needs to run on a SIS Group or on a single SIS/Managed CI}}
 
−
{{Bullet1|Protocol|The Discovery process once a computer has been identified as a Windows device, Windows Management Instrumentation (WMI) is used to retrieve Windows Information that is used to populate the Inventory.  The discovery Job will always be executed directly from the SIS server and thus needs to remotely connect with any computers that it discovers to retrieve their details.  There are two methods supported, that can be utilised:}}
 
−
{{Bullet2|WinRm|Provides secure and firewall-friendly communications, in order to access WMI. This feature is supported on Windows 2008R2 and later, Windows 7 and later and later.}}
 
−
{{Bullet2|DCOM|Communication relies on Remote Procedure Calls and can be tricky to configure over firewalls.}}
 
−
{{Bullet1|Discovery Mode|The Discover Mode dictates the method that identifies devices on the Network.  Each Mode will have specific settings; these will be visible in the Discover Mode Settings.  It is only possible to have a single mode per Job use of multiple modes, will require the creation of multiple Jobs.}}
 
−
{{Bullet2|[[Active Directory]]|}}
 
−
{{Bullet2|[[LDAP Server]]|}}
 
−
{{Bullet2|[[Manual List]]|}}
 
−
{{Bullet2|[[Network Enumeration]]|}}
 
−
{{Bullet2|[[Browser Service List]]|}}
 
−
 
 
−
{{Bullet1|Ping Check Settings|}}
 
−
{{Bullet2|Ping check Discovered|[Yes / No] Check that the discovered machine is pinged - if ICMP is disabled or firewalled, then select "No"}}
 
−
{{Bullet2|Timeout|}}
 
−
{{Bullet2|Hop Count|}}
 
−
 
 
−
[[Category:ITOM]]
 
−
 
 
−
== 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 monitoring the progress and to aid with troubleshooting failures.
 
−
 
 
−
{{Bullet1|Summary|Shows the current status of the job and its name along with who created it and when}}
 
−
{{Bullet1|Discovery Options|Displays details of the options used by the discovery process, this will differ depending on the discovery mode that is being used}}
 
−
{{Bullet1|Target Information|Provides details of the SIS server that will facilitate the job, target machine and the security keys used}}
 
−
{{Bullet1|Execution Details|The execution details show when the job was started and completed along with any result code}}
 
−
[[Category:ITOM]]
 
−
 
 
−
== Creating a Job ==
 
 
# Select the '''Create New''' button
 
# Select the '''Create New''' button
 
# Select '''Discover Job'''
 
# Select '''Discover Job'''
Line 55: Line 27:
 
# Enter the relevant Discovery Mode Settings
 
# Enter the relevant Discovery Mode Settings
 
# Click Create button
 
# Click Create button
 +
[[Category:ITOM]]
 +
 +
==Job Properties==
 +
{{Bullet1|Name|Name given to identify this Discovery Job}}
 +
{{Template:ITOM Discovery Job Properties}}
 +
 +
== Job Details ==
 +
Once created, the details of the job will be displayed, showing information relating to the status of the job.  The progress of the job is available via the Monitor, Console with Debug Logging provided to aid with troubleshooting failures.
 +
 +
{{Bullet1|Summary|Shows the current status of the job and its name along with who created it and when}}
 +
{{Bullet1|Discovery Options|Displays details of the options used by the discovery process, this will differ depending on the discovery mode used}}
 +
{{Bullet1|Target Information|Provides details of the SIS server that will facilitate the job, target machine and the security keys used}}
 +
{{Bullet1|Execution Details|The execution details show when the job was started and completed along with any result code}}
 +
[[Category:ITOM]]
  
−
===Monitor===
+
===Execution Log===
−
The Monitor frame provides information relating to the execution of the job; the details shown will be dependant on the method of discovery used.   
+
The Execution Log provides information relating to the execution of the job; the details shown will be dependant on the method of Discovery used.   
  
 
[[image:jobMonitorADDiscovery.png]]
 
[[image:jobMonitorADDiscovery.png]]
  
−
The above example shows that the discovery has started and has initiated two processes, Standalone (EspSiSExec.exe) and a Payload (ESPSisDiscovery.exe), on the SIS server.
+
The above example shows that the Discovery has started and has initiated two processes, Standalone (EspSiSExec.exe) and a Payload (ESPSisDiscovery.exe), on the SIS server.
  
 
All console output from the process is output, and confirmation of successful completion or failure will be output.
 
All console output from the process is output, and confirmation of successful completion or failure will be output.
Line 71: Line 57:
  
 
===Debug Log===
 
===Debug Log===
−
In cases where the Discovery may have failed or completed incorrectly, the Debug log can be used to review any errors and other technical information.
+
In cases where the Discovery may have failed or completed incorrectly, the Debug log, used to review any errors and other technical information.
  
 
[[image:jobDebugLogDiscovery.png]]
 
[[image:jobDebugLogDiscovery.png]]
Line 79: Line 65:
 
{{Bullet1|Full|Full debug log information}}
 
{{Bullet1|Full|Full debug log information}}
 
{{Bullet1|Standard|Information log entries}}
 
{{Bullet1|Standard|Information log entries}}
−
{{Bullet1|Problem|Warning and Error, entries that may identify portential problems}}
+
{{Bullet1|Problem|Warning and Error, entries that may identify potential problems}}
  
 
{{infobox|The sections output will depend on the job, and thus some sections may not be available}}
 
{{infobox|The sections output will depend on the job, and thus some sections may not be available}}

Latest revision as of 07:31, 10 June 2021

Home > ITOM > Create New Job > Discovery Job Index

Introduction

A Discovery is executed from a designated SIS server, using one of the various methods provided. Once discovered, dependant on configuration, an optional ping request will also be sent to each device. Admin Credentials provided via the Hornbill KeySafe, used for access to the inventory of each device (e.g. hardware, operating system, installed programs) using WMI via DCOM, WinRM or SSH. For Unix / Linux devices Admin Credentials are used to access the inventory of each device using SSH. On successful completion, discovered device details are accessible within the ITOM Inventory.

Related Articles

Creating a Discovery

  1. Open the Hornbill Administration Tool
  2. Navigate to Home > ITOM > Job Queue
  3. Select the Create New button
  4. Select Discover Job
  5. Enter Name to identify the Job
  6. Select an SIS server:
    This can be a single Server or a Group
  7. Select the required Protocol
  8. Select the required Discovery Mode
  9. Enter the relevant Discovery Mode Settings
  10. Click Create button

Job Properties

  • Name
Name given to identify this Discovery Job
ITOM Add Discovery Job
  • Site Target [Group / Server ]
whether the job needs to run on an SIS Group or on a single SIS/Managed CI
  • Protocol
A device is identified as discovered once it can be accessed and its inventory retrieved. This is achieved by probing its Operating System (OS) using various methods dependant on the devices Operating System. The probe will be initiated from the SIS server and does not require any software to be uploaded to the device. In order to achieve this, a protocol will be required in order for the SIS to access the device. Which protocol will depend on the OS and what is supported, in general for Windows devices WMI is used along with DCOM or WinRM, and for Linux / Unix (inc Apple Mac) Secure Shell (SSH) is used.
  • Auto
Will attempt to access the device using all of the provided protocols, in the following order; WinRM, DCOM and SSH, using the first successful one.
  • WinRm
Provides secure and firewall-friendly communications, in order to access WMI. This feature is supported on Windows 2008R2 and later and Windows 7 and later.
  • DCOM
Communication relies on Remote Procedure Calls and can be tricky to configure over firewalls. Widely supported on the Windows platform, this protocol is mainly used to access legacy devices.
  • SSH
Secure Shell is a network communication protocol that allows for remote connection between two computers to communicate and share data, commonly used but not exclusively by Linux / Unix (inc Apple Mac) devices. The protocol can be used on Windows devices, but may require additional software to be installed and configured.
  • Discovery Mode
The Discover Mode dictates the method that identifies devices on the Network. Each mode will have specific settings; these will be visible in the Discover Mode Settings section. It is only possible to have a single mode per Job, use of multiple modes will require the creation of multiple Jobs.
  • Ping Check Settings
  • Ping check Discovered
[Yes / No] Check that the discovered machine is pinged - if ICMP is disabled or firewalled, then select "No"
  • Timeout
  • Hop Count

Job Details

Once created, the details of the job will be displayed, showing information relating to the status of the job. The progress of the job is available via the Monitor, Console with Debug Logging provided to aid with troubleshooting failures.

  • Summary
Shows the current status of the job and its name along with who created it and when
  • Discovery Options
Displays details of the options used by the discovery process, this will differ depending on the discovery mode used
  • 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

Execution Log

The Execution Log provides information relating to the execution of the job; the details shown will be dependant on the method of Discovery used.

JobMonitorADDiscovery.png

The above example shows that the Discovery has started and has initiated two processes, Standalone (EspSiSExec.exe) and a Payload (ESPSisDiscovery.exe), on the SIS server.

All console output from the process is output, and confirmation of successful completion or failure will be output.

Console Output

The Console Output is accessible once the job has been completed and will contain only the output produced by the payload, including any error messages.

JobConsoleADDiscovery.png

Debug Log

In cases where the Discovery may have failed or completed incorrectly, the Debug log, used to review any errors and other technical information.

JobDebugLogDiscovery.png

The Log provides three sections:

  • Full
Full debug log information
  • Standard
Information log entries
  • Problem
Warning and Error, entries that may identify potential problems
Information
The sections output will depend on the job, and thus some sections may not be available
Retrieved from "https://wiki.hornbill.com/index.php?title=Discovery_Job&oldid=26890"