-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add alert notification profile documentation for CLI command
- Loading branch information
1 parent
7ec7ae4
commit 42a473b
Showing
8 changed files
with
520 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: "ttn-lw-cli alert-notification-profiles" | ||
slug: ttn-lw-cli_alert_notification_profiles | ||
--- | ||
|
||
## ttn-lw-cli alert-notification-profiles | ||
|
||
Alert Notification profile commands (EXPERIMENTAL) | ||
|
||
``` | ||
ttn-lw-cli alert-notification-profiles [command] | ||
``` | ||
|
||
## Aliases: | ||
``` | ||
alert-notification-profiles, alert-profiles, anp | ||
``` | ||
|
||
## Available Commands: | ||
``` | ||
create Create an alert notification profile (EXPERIMENTAL) | ||
delete Delete an alert notification profile (EXPERIMENTAL) | ||
get Get an alert notification profile (EXPERIMENTAL) | ||
get-default Get default alert notification profile (EXPERIMENTAL) | ||
list List alert notification profiles (EXPERIMENTAL) | ||
update Update an alert notification profile (EXPERIMENTAL) | ||
``` | ||
|
||
### Options | ||
``` | ||
-h, --help help for alert-notification-profiles | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--allow-unknown-hosts Allow sending credentials to unknown hosts | ||
--application-server-enabled Application Server enabled (default true) | ||
--application-server-grpc-address string Application Server address (default "localhost:8884") | ||
--ca string CA certificate file | ||
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,/home/nick/.ttn-lw-cli.yml,/home/nick/.config/.ttn-lw-cli.yml]) | ||
--credentials-id string Credentials ID (if using multiple configurations) | ||
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") | ||
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") | ||
--dump-requests When log level is set to debug, also dump request payload as JSON | ||
--experimental.features strings Experimental features to activate | ||
--gateway-server-enabled Gateway Server enabled (default true) | ||
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884") | ||
--identity-server-grpc-address string Identity Server address (default "localhost:8884") | ||
--input-format string Input format (default "json") | ||
--insecure Connect without TLS | ||
--join-server-enabled Join Server enabled (default true) | ||
--join-server-grpc-address string Join Server address (default "localhost:8884") | ||
--log.format string Log format to write (console, json) (default "console") | ||
--log.level string The minimum level log messages must have to be shown (default "info") | ||
--network-server-enabled Network Server enabled (default true) | ||
--network-server-grpc-address string Network Server address (default "localhost:8884") | ||
--oauth-server-address string OAuth Server address (default "https://localhost/oauth") | ||
--output-format string Output format (default "json") | ||
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") | ||
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") | ||
--retry.default-timeout duration Default timeout between retry attempts (default 100ms) | ||
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) | ||
--retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts | ||
--retry.max uint Maximum amount of times that a request can be reattempted | ||
--skip-version-check Do not perform version checks | ||
--telemetry.enable Enables telemetry for CLI (default true) | ||
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface | ||
* [ttn-lw-cli alert-notification-profiles create]({{< relref "ttn-lw-cli_alert_notification_profiles_create" >}}) - Alert notification profile create command | ||
* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert_notification_profiles_get" >}}) - Alert notification profile get command | ||
* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert_notification_profiles_get_default" >}}) - Alert notification profile get-default command | ||
* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert_notification_profiles_list" >}}) - Alert notification profile list command | ||
* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert_notification_profiles_update" >}}) - Alert notification profile update command | ||
* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert_notification_profiles_delete" >}}) - Alert notification profile delete command |
75 changes: 75 additions & 0 deletions
75
doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
title: "ttn-lw-cli alert-notification-profiles create" | ||
slug: ttn-lw-cli_alert_notification_profiles_create | ||
--- | ||
|
||
## ttn-lw-cli alert-notification-profiles create | ||
|
||
Create an alert notification profile (EXPERIMENTAL) | ||
|
||
``` | ||
ttn-lw-cli alert-notification-profiles create [profile-id] [flags] | ||
``` | ||
|
||
## Aliases: | ||
``` | ||
create, add, register | ||
``` | ||
|
||
### Options | ||
``` | ||
--description string | ||
-h, --help help for create | ||
--ids.profile-id string | ||
--is-default | ||
--name string | ||
--profile-id string | ||
--receivers-ids strings set profile receiver IDs | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--allow-unknown-hosts Allow sending credentials to unknown hosts | ||
--application-server-enabled Application Server enabled (default true) | ||
--application-server-grpc-address string Application Server address (default "localhost:8884") | ||
--ca string CA certificate file | ||
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,/home/nick/.ttn-lw-cli.yml,/home/nick/.config/.ttn-lw-cli.yml]) | ||
--credentials-id string Credentials ID (if using multiple configurations) | ||
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") | ||
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") | ||
--dump-requests When log level is set to debug, also dump request payload as JSON | ||
--experimental.features strings Experimental features to activate | ||
--gateway-server-enabled Gateway Server enabled (default true) | ||
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884") | ||
--identity-server-grpc-address string Identity Server address (default "localhost:8884") | ||
--input-format string Input format (default "json") | ||
--insecure Connect without TLS | ||
--join-server-enabled Join Server enabled (default true) | ||
--join-server-grpc-address string Join Server address (default "localhost:8884") | ||
--log.format string Log format to write (console, json) (default "console") | ||
--log.level string The minimum level log messages must have to be shown (default "info") | ||
--network-server-enabled Network Server enabled (default true) | ||
--network-server-grpc-address string Network Server address (default "localhost:8884") | ||
--oauth-server-address string OAuth Server address (default "https://localhost/oauth") | ||
--output-format string Output format (default "json") | ||
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") | ||
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") | ||
--retry.default-timeout duration Default timeout between retry attempts (default 100ms) | ||
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) | ||
--retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts | ||
--retry.max uint Maximum amount of times that a request can be reattempted | ||
--skip-version-check Do not perform version checks | ||
--telemetry.enable Enables telemetry for CLI (default true) | ||
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface | ||
* [ttn-lw-cli alert-notification-profiles create]({{< relref "ttn-lw-cli_alert_notification_profiles_create" >}}) - Alert notification profile create command | ||
* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert_notification_profiles_get" >}}) - Alert notification profile get command | ||
* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert_notification_profiles_get_default" >}}) - Alert notification profile get-default command | ||
* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert_notification_profiles_list" >}}) - Alert notification profile list command | ||
* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert_notification_profiles_update" >}}) - Alert notification profile update command | ||
* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert_notification_profiles_delete" >}}) - Alert notification profile delete command |
64 changes: 64 additions & 0 deletions
64
doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_delete.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: "ttn-lw-cli alert-notification-profiles delete" | ||
slug: ttn-lw-cli_alert_notification_profiles_delete | ||
--- | ||
|
||
## ttn-lw-cli alert-notification-profiles delete | ||
|
||
Delete an alert notification profile (EXPERIMENTAL) | ||
|
||
``` | ||
ttn-lw-cli alert-notification-profiles delete [profile-id] [flags] | ||
``` | ||
|
||
### Options | ||
``` | ||
-h, --help help for delete | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--allow-unknown-hosts Allow sending credentials to unknown hosts | ||
--application-server-enabled Application Server enabled (default true) | ||
--application-server-grpc-address string Application Server address (default "localhost:8884") | ||
--ca string CA certificate file | ||
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,/home/nick/.ttn-lw-cli.yml,/home/nick/.config/.ttn-lw-cli.yml]) | ||
--credentials-id string Credentials ID (if using multiple configurations) | ||
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884") | ||
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884") | ||
--dump-requests When log level is set to debug, also dump request payload as JSON | ||
--experimental.features strings Experimental features to activate | ||
--gateway-server-enabled Gateway Server enabled (default true) | ||
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884") | ||
--identity-server-grpc-address string Identity Server address (default "localhost:8884") | ||
--input-format string Input format (default "json") | ||
--insecure Connect without TLS | ||
--join-server-enabled Join Server enabled (default true) | ||
--join-server-grpc-address string Join Server address (default "localhost:8884") | ||
--log.format string Log format to write (console, json) (default "console") | ||
--log.level string The minimum level log messages must have to be shown (default "info") | ||
--network-server-enabled Network Server enabled (default true) | ||
--network-server-grpc-address string Network Server address (default "localhost:8884") | ||
--oauth-server-address string OAuth Server address (default "https://localhost/oauth") | ||
--output-format string Output format (default "json") | ||
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884") | ||
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884") | ||
--retry.default-timeout duration Default timeout between retry attempts (default 100ms) | ||
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true) | ||
--retry.jitter float Fraction that deletes a deviation of the timeout used between retry attempts | ||
--retry.max uint Maximum amount of times that a request can be reattempted | ||
--skip-version-check Do not perform version checks | ||
--telemetry.enable Enables telemetry for CLI (default true) | ||
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface | ||
* [ttn-lw-cli alert-notification-profiles create]({{< relref "ttn-lw-cli_alert_notification_profiles_create" >}}) - Alert notification profile create command | ||
* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert_notification_profiles_get" >}}) - Alert notification profile get command | ||
* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert_notification_profiles_get_default" >}}) - Alert notification profile get-default command | ||
* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert_notification_profiles_list" >}}) - Alert notification profile list command | ||
* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert_notification_profiles_update" >}}) - Alert notification profile update command | ||
* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert_notification_profiles_delete" >}}) - Alert notification profile delete command |
Oops, something went wrong.