On This Page

Home / Edge/ Administering·Scripts

Scripts

Admins can run scripts (e.g., shell scripts) from within Cribl Edge by configuring and executing them at Settings > Global Settings > Scripts. Scripts are typically used to call custom automation jobs or, more generally, to trigger tasks on demand. For example, you can use Scripts to run an Ansible job, or to place a call to another automation system, when Cribl Stream configs are updated.

Scripts are available only in customer-managed (on-prem) deployments, not in Cribl.Cloud.

With Great Power Comes Great Responsibility!
​

Scripts will allow you to execute almost anything on the system where Cribl Edge is running. Make sure you understand the impact of what you’re executing before you do so!

Settings > Manage Scripts page
Settings > Manage Scripts page

The Manage Scripts page provides the following tields:

  • ID: Unique ID for this script.
  • Command: Command to execute for this script.
  • Description: Brief description about this script. Optional.
  • Arguments: Arguments to pass when executing this script.
  • Env variables: Extra environment variables to set when executing script.
Scripts in Distributed Deployments
​

  • Scripts can be deployed from the Leader Node, but can be run only locally from each Worker Node.

  • If the Script command is referencing a file (e.g., 420.sh), that file must exist on the Cribl Stream instance. In other words, the Script management interface cannot be used to upload or manage script files.