Skip to main content
Version: NG-3.2

Script Executor

Introduction​

Script Executor lets you configure a single custom command or script to run on a target host via the Healthprobe's exec metricset — either a short inline one-liner or a full multi-line script, executed locally on the target (Windows or Linux) and shipped to its own dynamically-created I/O stream and hyperscale datastore schema. To run multiple commands/scripts on the same host, configure multiple Script Executor instances, each with its own Executor Instance ID.

Getting Started​

Compatibility​

Script Executor supports Windows Server 2016+ and common Linux distributions.

Data Collection Method​

vuSmartMaps runs a single user-configured command/script locally on the target, shipping its output to vuSmartMaps. Configure multiple Script Executor instances to run multiple commands/scripts on the same target.

Prerequisites​

Inputs for Configuring Data Source​

  • Executor Instance ID: Unique identifier for this Script Executor instance. Drives both the listing identifier and the dedicated I/O stream and hyperscale datastore schema created for this instance's data. Use only letters, numbers, underscores, and hyphens.
  • Storage Mode: "Shared" (default) sends this instance's output into a common I/O stream and hyperscale datastore schema used by every Script Executor instance in "Shared" mode, avoiding one extra stream/schema per instance. Choose "Dedicated" if this instance's output needs its own separately isolated I/O stream and hyperscale datastore schema instead.
  • Target Host: The IP Address/FQDN of the target system where these commands/scripts will execute. Used as metadata only (the exec commands always run locally where the agent is installed).
  • Target OS: Operating system of the target host. Determines which OmniAgent Healthprobe is installed and which per-language script bundle (bash/PowerShell) actually runs on this instance — pick the interpreter for each command below to match.
  • Period [in seconds]: How frequently the configured commands/scripts are executed. Period should be between 60 seconds and 86400 seconds (24 hours).
  • Command Label: Identifies this command/script — used as the resulting event's type (document_type). Use only letters, numbers, underscores, and hyphens.
  • Command Type: "Inline Command" runs a single short command/one-liner directly via the chosen Interpreter. "Full Script" runs a complete multi-line script body from the matching per-language script file below. Fill in the matching field below. Note: "Full Script" is not supported when Interpreter is "Custom Executable" — that combination silently runs nothing.
  • Interpreter: How this specific command is executed. "Bash"/"PowerShell"/"Python 3" run via the matching interpreter (only meaningful on the matching Target OS). "Custom Executable" invokes any pre-installed/pre-compiled program (e.g. a compiled Go program) directly — provide its full path below. WARNING: "Full Script" mode is not supported with "Custom Executable" — if you pick this combination, no command will run at all (silently). Use "Inline Command" instead, with the executable's arguments as the command.
  • Custom Executable Path: Used when Interpreter is "Custom Executable": the full path to the program to run on the target (e.g. a pre-installed Go program). Ignored for all other Interpreter choices.
  • Inline Command: Used when Command Type is "Inline Command": a single command line. For Bash/PowerShell/Python 3, executed directly via that interpreter. For Custom Executable, these are the arguments passed to Custom Executable Path. Ignored when Command Type is "Full Script".
  • Script Body: Used when Command Type is "Full Script": the full multi-line script content, run from the script file matching this instance's Interpreter (Bash/PowerShell/Python 3 only). Ignored when Command Type is "Inline Command" or Interpreter is "Custom Executable" (that combination is not supported and silently runs nothing).
  • Script Arguments: Optional, fixed arguments passed to the script every time it runs (Healthprobe exec commands are static, so this is not filled in dynamically per run). Used with "Full Script" mode: e.g. --verbose "some value". Ignored for "Inline Command" (put arguments directly in Inline Command instead).
Applications​

Firewall Requirement​

To collect data from this O11ySource, ensure the following ports are opened:

Source IPDestination IPDestination PortProtocolDirection
IP address of the target systemvuSmartMaps Collection/Ingress node IP443TCPInbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target​

Ensure the account running the OmniAgent Healthprobe has permission to execute the configured commands/scripts on the target.

Configuration Steps​

Metrics Collected​

The metrics are based on the input data collected.