Chapter 13: Custom Scripts

Custom Scripts

You can create custom scripts for diagnostics, additional network/device scans, to identify specific services, or any specific network reconnaissance. The Scripts section is a built-in programming editor you can use to create or paste any non-interactive Bash, Ruby, or Python script that you can run on your sensor as a custom task.

Note

Pulse does not support the creation of interactive scripts.

Creating a New Script

Open the Scripts tab.
Select Add a script.
Enter a Name for the script, and select Ruby, Python or Bash.
Input, or build out your script.
Click Save.

Custom Variables

When creating a script in Pulse, you can define custom variables. After a new custom variable is defined, Pulse dynamically adds it as a custom option when the script is scheduled to run as a custom task. You can re-use the script in varying contexts, without rewriting the script to meet new requirements. For example, you can use a custom variable to specify the required switches of a particular command. Use double curly braces ( {{ }} ) to enclose custom variables within the script itself. Text inside the double braces are used as the variable’s name.

Running a Script

You use Tasks to run scripts. The new script is available in the Tasks drop-down list when creating a new task.

The task will run the script with the permissions of the Root user on the sensor. Any results written to STDOUT or STDERR are recorded and returned to Pulse as results.

Script output is located in the Task section of Pulse. On the Tasks tab, click Results for the custom task that ran the script.

_Copyright

_{© 2024 Outpost24® All rights reserved.}_{This document may only be redistributed unedited and unaltered. This document may be cited and referenced only if clearly crediting Outpost24® and this document as the source. Any other reproduction and redistribution in print or electronically is strictly prohibited without explicit permission.}

_Trademark

_{Outpost24® and OUTSCAN™ are trademarks of Outpost24® and its affiliated companies. All other brand names, product names or trademarks belong to their respective owners.}