Aggregate alerts

Manage aggregate alerts.

Usage:

shell

humioctl aggregate-alerts [command]

Use humioctl aggregate-alerts [command] --help for more information about a command.

Table: Aggregate alert commands

Parameter	Description
`Export`	Export an aggregate alert <aggregate-alert> in <view> to a file.
`Export all`	Export all aggregate alerts
`Install`	Install an aggregate alert in a view.
`List`	List all aggregate alerts in a view.
`Remove`	Remove an aggregate alert.
`Show`	Show details about an aggregate alert in a view.

Table: Local flags

Parameter	Description
`-h, --help`	Help for aggregate-alerts

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 an aggregate alert <aggregate-alert> in <view> to a file.

Usage:

shell

humioctl aggregate-alerts export [flags] <view> <aggregate-alert>

Table: Local flags

Parameter	Description
`-h, --help`	Help for export
`-o, --output string`	The file path where the aggregate alert should be written. Defaults to `./<aggregate-alert-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 aggregate alerts to YAML files with naming <sanitized-aggregate-alert-name>.yaml. All non-alphanumeric characters will be replaced with underscore.

Usage:

shell

humioctl aggregate-alerts export-all <view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for export-all
`-d, --outputDirectory string`	The file path where the aggregate alerts should be written. Defaults to the 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 an aggregate alert from a URL or from a local file, for example:

shell

humioctl aggregate-alerts install viewName --url=https://example.com/acme/aggregate-alert.yaml
humioctl aggregate-alerts install viewName --file=./aggregate-alert.yaml

Usage:

shell

humioctl aggregate-alerts install [flags] <view>

Table: Local flags

Parameter	Description
`--file string`	The local file path to the aggregate alert to install.
`-h, --help`	Help for install
`-n, --name name`	Install the aggregate alert under a specific name, ignoring the name attribute in the aggregate alert file.
`--url string`	A URL to fetch the aggregate alert 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 aggregate alerts in a view.

Usage:

shell

humioctl aggregate-alerts 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 the aggregate alert <name> from <view>.

Usage:

shell

humioctl aggregate-alerts 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 an aggregate alert in a view.

Usage:

shell

humioctl aggregate-alerts 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)