.clear options
The .clear options command disables set-statement options.
// disable all set-statement options configured for your account
.clear optionsPurpose
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 Type | Permissions |
|---|---|
| Admin | Can disable any options configured for any scope. |
| Editor or User | Can disable only those options that they configured themselves. |
Syntax
.clear [Scope] options [with(reason="DeactivationReason")]
Parameters
| Parameter | Type | Description |
|---|---|---|
Scope | string | Scope of deactivation:
|
DeactivationReason | string | A 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.")