Parsers
Manage parsers.
Usage:
shell
humioctl parsers [command]Use humioctl parsers [command] --help for more information about a command.
Table: Parsers commands
| Parameter | Description |
|---|---|
Export | Export a parser <parser> in <repo> to a file. |
Install | Install a parser in a repository. |
List | List all installed parsers in a repository. |
Remove | Remove (uninstall) a parser from a repository. |
Show | Show details for a parser in a repository. |
Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for parsers |
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 parser <parser> in <repo> to a file.
Usage:
shell
humioctl parsers export [flags] <repo> <parser>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for export |
-o, --output string |
The file path where the parser should be written. Defaults to
./<parser-name>.yaml
|
Hide 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 parser from a URL or from a local file, for example:
shell
humioctl parsers install --url=https://example.com/acme/parser.yaml
humioctl parsers install --file=./parser.yaml
By default, install does not override existing parsers with the same
name. Use --allow-overwriting-existing-parser to
update an already-installed parser.
Usage:
shell
humioctl parsers install [flags] <repo>Table: Local flags
| Parameter | Description |
|---|---|
--allow-overwriting-existing-parser | Override any existing parser with the same name. Use this to update already-installed parsers. |
--file string | The local file path to the parser to install. |
-h, --help | Help for install |
-n, --name name | Install the parser under a specific name, ignoring the name attribute in the parser file. |
--url string | A URL to fetch the parser file from. |
Hide 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 installed parsers in a repository.
Usage:
shell
humioctl parsers list <repo> [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for list |
Hide 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 (uninstall) a parser from a repository.
Usage:
shell
humioctl parsers remove <repo> <parser> [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for remove |
Hide 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 for a parser in a repository.
Usage:
shell
humioctl parsers show <repo> <parser> [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for show |
Hide 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. |