ON THIS PAGE

Home / Stream/ Reference/ CLI Reference/vars

vars

Manages Cribl Stream global variables.

See Global Variables for more information.

Sub-commands:

Sub-commands and Options
​

vars add
​

Add a global variable.

Usage:

./cribl vars add -i exampleVariable -v 42 -t number -d "Sample number variable" -c cribl,sample

Sample response:

[
  {
    "type": "number",
    "lib": "cribl",
    "description": "Sample number variable",
    "value": "42",
    "tags": "cribl,sample",
    "id": "exampleVariable"
  }
]

Arguments:

OptionDefinition
-i <id>Global variable ID.
-t <type>Type.
-v <value>Value.
-a <args>Arguments.
-d <description>Description.
-c <tags>Custom Tags (comma separated list).
-g <group>Group ID.

vars get
​

List global variables.

Usage:

./cribl vars list

Arguments:

OptionDefinition
-i <id>Global variable ID.
-g <group>Group ID.

vars remove
​

Remove global variable.

Usage:

./cribl vars remove -i exampleVariable

Arguments:

OptionDefinition
-i <id>Global variable ID.
-g <group>Group ID.

vars update
​

Update global variable.

Usage:

./cribl vars update -i exampleVariable -v 2001

Arguments:

OptionDefinition
-i <id>Global variable ID.
-t <type>Type.
v <value>Value.
-a <args>Arguments.
-d <description>Description.
-c <tags>Custom Tags (comma separated list).
-g <group>Group ID.