On This Page

Home / Search/ Language Reference/ Commands/.clear options

.clear options

The .clear options command disables set-statement options.

// disable all set-statement options configured for your account
.clear options
Run in Cribl Search

Purpose
​

Use .clear options to disable options that were configured by set statements.

To see which set-statement options affect your account at the moment before running .clear options, use the .show options command.

Permissions
​

Search Member TypePermissions
AdminCan disable any options configured for any scope.
Editor or UserCan disable only those options that they configured themselves.

Syntax
​

     .clear [Scope] options [with(reason="DeactivationReason")]

Parameters
​

ParameterTypeDescription
ScopestringScope of deactivation:
  • user (default): Deactivate all options that the current user set for their own account.
  • global (Admin only): Deactivate all options set for all users in the matching Usage Group.
  • all (Admin only): Deactivate according to both the user and global scopes.
DeactivationReasonstringA string that provides a reason for disabling the options, to add to the Cribl Search audit log.

Returns
​

Returns a single event that confirms the options are disabled.

Examples
​

Disable all set-statement options configured for your own account.

.clear user options
            with(reason = "Clearing all my options.")

Disable all set-statement options of all users in the Usage Group.

// Admin only
.clear global options
              with(reason = "Clearing all options for my users.")

Disable all set-statement options, both for your own account and for all users in the Usage Group.

// Admin only
.clear all options
           with(reason = "Clearing all options for me and my users.")