From dee842c346f17f59ca48ec48d2b6eaaa8a6ae7cb Mon Sep 17 00:00:00 2001 From: Nicholas Cristofaro Date: Mon, 23 Oct 2023 18:19:10 -0300 Subject: [PATCH] doc: Add alert notification profile documentation for CLI command --- doc/content/ttn-lw-cli/ttn-lw-cli.md | 1 + .../ttn-lw-cli_alert_notification_profiles.md | 79 +++++++++++++++++++ ...-cli_alert_notification_profiles_create.md | 75 ++++++++++++++++++ ...-cli_alert_notification_profiles_delete.md | 64 +++++++++++++++ ...-lw-cli_alert_notification_profiles_get.md | 74 +++++++++++++++++ ...alert_notification_profiles_get_default.md | 74 +++++++++++++++++ ...lw-cli_alert_notification_profiles_list.md | 77 ++++++++++++++++++ ...-cli_alert_notification_profiles_update.md | 76 ++++++++++++++++++ 8 files changed, 520 insertions(+) create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_create.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_delete.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get_default.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_list.md create mode 100644 doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_update.md diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli.md b/doc/content/ttn-lw-cli/ttn-lw-cli.md index f10fbd1b42..661bb27bab 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli.md @@ -47,6 +47,7 @@ The Things Industries Command-line Interface ### SEE ALSO +* [ttn-lw-cli alert-notification-profiles]({{< relref "ttn-lw-cli_alert_notification_profiles" >}}) - Alert Notification profile commands * [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert_notification_receivers" >}}) - Alert Notification Receiver commands * [ttn-lw-cli applications]({{< relref "ttn-lw-cli_applications" >}}) - Application commands * [ttn-lw-cli authentication-providers]({{< relref "ttn-lw-cli_authentication-providers" >}}) - Authentication Provider commands diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles.md new file mode 100644 index 0000000000..ed00e5535a --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles.md @@ -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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_create.md new file mode 100644 index 0000000000..567e72fbed --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_create.md @@ -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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_delete.md new file mode 100644 index 0000000000..04fa833aa5 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_delete.md @@ -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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get.md new file mode 100644 index 0000000000..94878deb7c --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get.md @@ -0,0 +1,74 @@ +--- +title: "ttn-lw-cli alert-notification-profiles get" +slug: ttn-lw-cli_alert_notification_profiles_get +--- + +## ttn-lw-cli alert-notification-profiles get + +Get an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles get [profile-id] [flags] +``` + +## Aliases: +``` +get, info +``` + +### Options +``` + --description select the description field + -h, --help help for get + --is-default select the is_default field + --name select the name field + --profile-id select the profile_id field + --receivers select the receivers field +``` + +### 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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get_default.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get_default.md new file mode 100644 index 0000000000..2bf25f9c73 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_get_default.md @@ -0,0 +1,74 @@ +--- +title: "ttn-lw-cli alert-notification-profiles get-default" +slug: ttn-lw-cli_alert_notification_profiles_get_default +--- + +## ttn-lw-cli alert-notification-profiles get-default + +Get default alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles get-default [flags] +``` + +## Aliases: +``` +get-default, default +``` + +### Options +``` + --description select the description field + -h, --help help for get-default + --is-default select the is_default field + --name select the name field + --profile-id select the profile_id field + --receivers select the receivers field +``` + +### 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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_list.md new file mode 100644 index 0000000000..0263421ee5 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_list.md @@ -0,0 +1,77 @@ +--- +title: "ttn-lw-cli alert-notification-profiles list" +slug: ttn-lw-cli_alert_notification_profiles_list +--- + +## ttn-lw-cli alert-notification-profiles list + +List an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles list [flags] +``` + +## Aliases: +``` +list, ls +``` + +### Options +``` + --description select the description field + -h, --help help for list + --is-default select the is_default field + --limit uint32 maximum number of results to get (default 50) + --name select the name field + --order string order by this field + --page uint32 results page number (default 1) + --profile-id select the profile_id field + --receivers select the receivers field +``` + +### 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 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_update.md new file mode 100644 index 0000000000..5d3398b366 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert_notification_profiles_update.md @@ -0,0 +1,76 @@ +--- +title: "ttn-lw-cli alert-notification-profiles update" +slug: ttn-lw-cli_alert_notification_profiles_update +--- + +## ttn-lw-cli alert-notification-profiles update + +Update an alert notification profile (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles update [profile-id] [flags] +``` + +## Aliases: +``` +update, set +``` + +### Options +``` + --description string + -h, --help help for update + --ids.profile-id string + --is-default + --name string + --profile-id string + --receivers-ids strings set profile receiver IDs + --unset strings list of fields to unset +``` + +### 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