Actions
Manage actions.
Usage:
humioctl actions [command]Use humioctl actions [command] --help for more information about a command.
Table: Actions commands
| Parameter | Description |
|---|---|
Export | Export an action <action> in <repo-or-view> to a file. |
Export all | Export all actions |
Install | Install an action in a view. |
List | List all actions in a repository or view. |
Remove | Remove an action. |
Show | Show details about an action in a repository or view. |
Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for actions |
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 action <action> in <repo-or-view> to a file.
Usage:
humioctl actions export [flags] <repo-or-view> <action>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for actions |
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. |
Export all
Export all actions to YAML files with naming <sanitized-action-name>.yaml. All non-alphanumeric characters will be replaced with underscore.
Usage:
humioctl actions export-all <view> [flags]Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for export-all |
-d, --outputDirectory string | The file path where the actions should be written. Defaults to the current directory. |
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 an action from a URL or from a local file, for example:
humioctl actions install viewName --name actionName --url=https://example.com/acme/action.yaml
humioctl actions install viewName --name actionName --file=./action.yaml
humioctl actions install viewName --file=./action.yaml
By default, install does not override existing actions with the same name.
Use --force to update existing actions with conflicting
names.
Usage:
humioctl actions install [flags] <repo-or-view>Table: Local flags
| Parameter | Description |
|---|---|
--file string | The local file path to the action to install. |
-h, --help | Help for install |
-n, --name name | Install the action under a specific name, ignoring the name attribute in the action file. |
--url string | A URL to fetch the action 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 actions in a repository or view.
Usage:
humioctl actions list <repo-or-view> [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 the action <name> from <repo-or-view>.
Usage:
humioctl actions remove <repo-or-view> <name> [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 about an action in a repository or view.
Usage:
humioctl actions show <repo-or-view> <name> [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. |