Scheduled searches V2

Manage scheduled searches.

Usage:

shell

humioctl scheduled-searches-v2 [command]

Use humioctl scheduled-searches-v2 [command] --help for more information about a command.

Table: Scheduled searches V2 commands

Parameter	Description
`Export`	Export a scheduled search to a file.
`Export all`	Export all scheduled searches to YAML files.
`Install`	Install a scheduled search in a view.
`List`	List all scheduled searches in a view.
`Remove`	Remove a scheduled search from a view.
`Show`	Show details about a scheduled search in a view.

Table: Local flags

Parameter	Description
`-h, --help`	Help for scheduled-searches-v2

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Export

Export a scheduled search in a view to a file.

Usage:

shell

humioctl scheduled-searches-v2 export [flags] <view> <scheduled-search>

Table: Local flags

Parameter	Description
`-h, --help`	Help for export
`-o, --output string`	The file path where the scheduled search is written. Default: `./scheduled-search-name.yaml`.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Export all

Export all scheduled searches to YAML files. File names use the format sanitized-scheduled-search-name.yaml.

Usage:

shell

humioctl scheduled-searches-v2 export-all <view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for export-all
`-d, --outputDirectory string`	The directory where the scheduled search files are written. Default: current directory.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Install

Install a scheduled search from a URL or from a local file, for example:

shell

humioctl scheduled-searches-v2 install viewName --url=https://example.com/acme/scheduled-search-v2.yaml
humioctl scheduled-searches-v2 install viewName --file=./scheduled-search-v2.yaml

Note

Passing a v1 YAML file installs the scheduled search using the legacy CreateScheduledSearch mutation, which is deprecated.

Usage:

shell

humioctl scheduled-searches-v2 install [flags] <view>

Table: Local flags

Parameter	Description
`--file string`	The local file path to the scheduled search to install.
`-h, --help`	Help for install
`-n, --name name`	Install the scheduled search under a specific name, ignoring the name attribute in the scheduled search file.
`--url string`	A URL to fetch the scheduled search file from.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

List

List all scheduled searches in a view.

Usage:

shell

humioctl scheduled-searches-v2 list <view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for list

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Remove

Remove a scheduled search from a view.

Usage:

shell

humioctl scheduled-searches-v2 remove <view> <name> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for remove

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Show

Show details about a scheduled search in a view.

Usage:

shell

humioctl scheduled-searches-v2 show <view> <name> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for show

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Versions of this Page

Command line tools and scripts

Command-Line Interface (humioctl)