Difference between revisions of "Rapid7 InsightVM"

From Hornbill
Jump to navigation Jump to search
(Created page with "{{bluebanner|Home > Administration > IT Operations Management > ITOM Package Library > Hyper-V|[[:Categ...")
 
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Hyper-V|[[:Category:ITOM|Index]]}}
+
This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library].
[[File:rapid7_logo.png|300px]]
 
{{IntroAndLinks|The Rapid7 InsightVM package for Hornbill's IT Operations Management (ITOM) contains operations to automate vulnerability management operations within Rapid7 InsightVM deployments.
 
|
 
<!-- Related Links go here -->
 
:* [[IT_Operations_Management|IT Operations Management]]
 
:* [[Business_Process_Designer|Business Process Designer]]
 
:* [[Hornbill_KeySafe|KeySafe]]
 
}}
 
  
==Target Environment Requirements==
+
    [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]]
 
+
[[Category:HDOC]]
===Script Execution Machine Requirements===
 
 
 
* If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. See the [https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6 PowerShell Documentation] for more information.
 
 
 
==KeySafe Configuration==
 
[[File:insightvm_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/5/5f/Insightvm_keysafe.png]]
 
 
 
When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges within your environment, and will require an additional KeySafe Key to hold the account credentials to connect to InsightVM.
 
 
 
To configure your '''Target Machine''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
 
 
 
* In the Admin console, navigate to: System > Security > KeySafe;
 
* Click on + then select <code>Username + Password</code>;
 
* Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
 
* Optionally add a description;
 
* Populate the Username field with the domain/local account username for the account being used on the target machine;
 
* Populate the Password field with the password for the above account;
 
* Select Create Key to save.
 
 
 
To configure your '''InsightVM''' account authentication in '''[[Hornbill_KeySafe|KeySafe]]''':
 
 
 
* In the Admin console, navigate to: System > Security > KeySafe;
 
* Click on + then select <code>Username + Password</code>;
 
* Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
 
* Optionally add a description;
 
* Populate the Username field with the Username of the InsightVM account that ITOM will use to perform the operations;
 
* Populate the Password field with the password for the above account;
 
* Endpoint - this should be populated with the API Endpoint for your Rapid7 InsightVM deployment. For example: '''https://{your.insightvm.hostname}:3780''' where {your.insightvm.hostname} should be replaced by the host domain of the InsightVM server, and 3780 is the default port for making API calls to the server;
 
* Select Create Key to save.
 
 
 
==Package Operations==
 
[[File:Insightvm_job.png|300px|right|link=https://wiki.hornbill.com/images/d/d5/Insightvm_job.png]]
 
 
 
The Rapid7 InsightVM package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks.
 
 
 
<div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
 
===Start Scan===
 
<div class="mw-collapsible-content">
 
Starts a Scan against a Host on a Site. See the [https://help.rapid7.com/insightvm/en-us/api/index.html#operation/startScan InsightVM operation documentation] for more information.
 
 
 
====Extra Credentials====
 
 
 
This operation requires an extra credential to be provided:
 
 
 
Credential Reference: credential1
 
Credential Keysafe Key Type: Username + Password
 
 
 
====Input Parameters====
 
 
 
* <code>IgnoreBadCerts</code> '''(MANDATORY)''' - When set to true, the IgnoreBadCerts input parameter will allow the operation to function even if the SSL certificate on your InsightVM deployment is self-certified or expired;
 
* <code>SiteID</code> '''(MANDATORY)''' - The ID of the Site to initiate the scan against;
 
* <code>EngineID</code> '''(MANDATORY)''' - The identifier of the scan engine;
 
* <code>Asset</code> '''(MANDATORY)''' - The IP or Name of the Asset to scan;
 
* <code>TemplateID</code> '''(MANDATORY)''' - The identifier of the scan template;
 
* <code>Name</code> - The user-driven scan name for the scan;
 
 
 
====Output Parameters====
 
 
 
* <code>errors</code> - Any errors returned by the operation;
 
* <code>outcome</code> - Outcome of the operation. Can be OK or FAIL;
 
* <code>id</code> - The ID of the Scan.
 
</div></div>
 
 
 
 
 
[[Category:ITOM]]
 

Latest revision as of 20:00, 10 April 2024

This document can now be found at its new location in the Hornbill Document Library.

   ITOM Package Reference