diff --git a/doc/config/_default/config.toml b/doc/config/_default/config.toml index fec94aabb2..46e4beabfd 100644 --- a/doc/config/_default/config.toml +++ b/doc/config/_default/config.toml @@ -24,7 +24,7 @@ pygmentsUseClasses = true github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs" github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content" tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack" - version = "3.28.2" + version = "3.29.0" [markup] [markup.goldmark] diff --git a/doc/content/reference/api/end_device.md b/doc/content/reference/api/end_device.md index dddde78d45..b6dca5d77f 100644 --- a/doc/content/reference/api/end_device.md +++ b/doc/content/reference/api/end_device.md @@ -522,8 +522,12 @@ See the [EndDevice message](#message:EndDevice) and its sub-messages for additio {{< proto/message message="Secret" >}} +{{< proto/message message="ServedRelaySettings" >}} + {{< proto/message message="ServedRelayParameters" >}} +{{< proto/message message="ServingRelaySettings" >}} + {{< proto/message message="ServingRelayParameters" >}} {{< proto/message message="RelayUplinkForwardingRule" >}} @@ -606,6 +610,8 @@ See the [EndDevice message](#message:EndDevice) and its sub-messages for additio {{< proto/enum enum="RelaySecondChAckOffset" >}} +{{< proto/message message="RelaySettings" >}} + {{< proto/enum enum="RelaySmartEnableLevel" >}} {{< proto/enum enum="RelayLimitBucketSize" >}} diff --git a/doc/content/reference/api/gateway.md b/doc/content/reference/api/gateway.md index 90c182811e..210d289c09 100644 --- a/doc/content/reference/api/gateway.md +++ b/doc/content/reference/api/gateway.md @@ -69,6 +69,8 @@ The Gateway Server exposes the list of available frequency plans with the `Confi ## Messages +{{< proto/message message="AlertNotificationProfileIdentifiers" >}} + {{< proto/message message="APIKey" >}} {{< proto/message message="APIKeys" >}} diff --git a/doc/content/reference/api/identity_server.md b/doc/content/reference/api/identity_server.md index 084a9e6ab6..45f8ef870e 100644 --- a/doc/content/reference/api/identity_server.md +++ b/doc/content/reference/api/identity_server.md @@ -51,8 +51,54 @@ description: "" {{< proto/method service="GatewayBatchRegistry" method="Delete" >}} +## The `AlertNotificationProfileRegistry` service + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Create" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Get" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="List" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Update" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="Delete" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationProfileRegistry" method="GetDefault" >}} + +## The `AlertNotificationReceiverRegistry` service + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Create" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Get" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="List" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Update" >}} + +{{< proto/method package="tti.lorawan.v3" service="AlertNotificationReceiverRegistry" method="Delete" >}} + +## The `Ars` service + +{{< proto/method package="tti.lorawan.v3" service="Ars" method="GetConfiguration" >}} + ## Messages +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationProfile" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiverIdentifiers" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Email" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.SMS" >}} + +{{< proto/message package="tti.lorawan.v3" message="AlertNotificationReceiver.Webhook" >}} + +{{< proto/message package="tti.lorawan.v3" message="ArsConfiguration" >}} + +{{< proto/message package="tti.lorawan.v3" message="ArsConfiguration.Routing" >}} + {{< proto/message message="AssertGatewayRightsRequest" >}} {{< proto/message package="tti.lorawan.v3" message="AuthenticationProvider" >}} @@ -71,6 +117,10 @@ description: "" {{< proto/message message="ContactInfoValidation" >}} +{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="CreateAlertNotificationReceiverRequest" >}} + {{< proto/message message="EndDeviceIdentifiers" >}} {{< proto/message message="EntityIdentifiers" >}} @@ -97,6 +147,16 @@ description: "" {{< proto/message message="GatewayIdentifiers" >}} +{{< proto/message package="tti.lorawan.v3" message="GetArsConfigurationRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetArsConfigurationResponse" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetDefaultAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="GetAlertNotificationReceiverRequest" >}} + {{< proto/message message="GetIsConfigurationRequest" >}} {{< proto/message message="GetIsConfigurationRequest" >}} @@ -107,6 +167,10 @@ description: "" {{< proto/message message="ListOAuthAccessTokensRequest" >}} +{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationProfilesRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="ListAlertNotificationReceiversRequest" >}} + {{< proto/message message="OAuthAccessToken" >}} {{< proto/message message="OAuthAccessTokenIdentifiers" >}} @@ -131,6 +195,10 @@ description: "" {{< proto/message message="SearchAccountsResponse" >}} +{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationProfileRequest" >}} + +{{< proto/message package="tti.lorawan.v3" message="UpdateAlertNotificationReceiverRequest" >}} + {{< proto/enum enum="ContactMethod" >}} diff --git a/doc/content/reference/api/network_server.md b/doc/content/reference/api/network_server.md index 6a65bf5812..4bd76285ea 100644 --- a/doc/content/reference/api/network_server.md +++ b/doc/content/reference/api/network_server.md @@ -171,6 +171,8 @@ description: "" {{< proto/message message="RelaySecondChannel" >}} +{{< proto/message message="RelaySettings" >}} + {{< proto/message message="RelayUplinkForwardLimits" >}} {{< proto/message message="RelayForwardLimits" >}} @@ -181,8 +183,12 @@ description: "" {{< proto/message message="RxMetadata" >}} +{{< proto/message message="ServedRelaySettings" >}} + {{< proto/message message="ServedRelayParameters" >}} +{{< proto/message message="ServingRelaySettings" >}} + {{< proto/message message="ServingRelayParameters" >}} {{< proto/message message="RelayUplinkForwardingRule" >}} diff --git a/doc/content/reference/api/tenant.md b/doc/content/reference/api/tenant.md index 0c1f401351..d781ee7c2e 100644 --- a/doc/content/reference/api/tenant.md +++ b/doc/content/reference/api/tenant.md @@ -45,6 +45,10 @@ Unlike the other services, the tenant services do **not** accept API keys or OAu {{< proto/message package="tti.lorawan.v3" message="BatchGetTenantRegistryTotalsRequest" >}} +{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.AlertRoutingServer" >}} + +{{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.AlertRoutingServer.Routing" >}} + {{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.IdentityServer.ApplicationLimits" >}} {{< proto/message package="tti.lorawan.v3" message="Configuration.Cluster.IdentityServer.OrganizationLimits" >}} diff --git a/doc/content/the-things-stack/host/aws/ecs/changelog/index.md b/doc/content/the-things-stack/host/aws/ecs/changelog/index.md index 736986bc29..0a30069022 100644 --- a/doc/content/the-things-stack/host/aws/ecs/changelog/index.md +++ b/doc/content/the-things-stack/host/aws/ecs/changelog/index.md @@ -9,6 +9,26 @@ All meaningful changes to templates are documented in this file. ## Unreleased +## 3.29.0 + +### `2-1-db-aurora-master`, `2-2-db-aurora-replica` + +- Update the default database engine version to `13.8`. +- Engine versions `14`, `15` and `16` are now supported. + +### `2-5-db-timescale` + +- Updated the default `node_exporter` version to `1.7.0`. +- Updated the default `postgres_exporter` version to `1.5.0`. +- Extension version `2.13.1` is now supported. +- Engine version `16` is now supported, but note that this requires an extension version of at least `2.13.1`. +- The default extension version is now `2.10.1`. +- The default engine version is now `15`. + +### `5-4-ecs-cluster` + +- Updated the default `node_exporter` version to `1.7.0`. + ## 3.28.2 ### Proxy diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli.md b/doc/content/ttn-lw-cli/ttn-lw-cli.md index 4e0e362b6e..64af5af63e 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli.md @@ -47,6 +47,8 @@ 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 (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) * [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 * [ttn-lw-cli clients]({{< relref "ttn-lw-cli_clients" >}}) - Client commands @@ -61,6 +63,7 @@ The Things Industries Command-line Interface * [ttn-lw-cli notifications]({{< relref "ttn-lw-cli_notifications" >}}) - Manage notifications * [ttn-lw-cli organizations]({{< relref "ttn-lw-cli_organizations" >}}) - Organization commands * [ttn-lw-cli packetbroker]({{< relref "ttn-lw-cli_packetbroker" >}}) - Packet Broker commands +* [ttn-lw-cli relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) * [ttn-lw-cli simulate]({{< relref "ttn-lw-cli_simulate" >}}) - Simulation commands * [ttn-lw-cli templates]({{< relref "ttn-lw-cli_templates" >}}) - End Device template commands * [ttn-lw-cli tenants]({{< relref "ttn-lw-cli_tenants" >}}) - Tenant 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..2e39455999 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles.md @@ -0,0 +1,62 @@ +--- +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) + +### 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/.ttn-lw-cli.yml,$HOME/.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" >}}) - Create an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles delete]({{< relref "ttn-lw-cli_alert-notification-profiles_delete" >}}) - Delete an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles get]({{< relref "ttn-lw-cli_alert-notification-profiles_get" >}}) - Get an alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles get-default]({{< relref "ttn-lw-cli_alert-notification-profiles_get-default" >}}) - Get default alert notification profile (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles list]({{< relref "ttn-lw-cli_alert-notification-profiles_list" >}}) - List alert notification profiles (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-profiles update]({{< relref "ttn-lw-cli_alert-notification-profiles_update" >}}) - Update an alert notification profile (EXPERIMENTAL) + 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..fa60adf8ef --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_create.md @@ -0,0 +1,66 @@ +--- +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] +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + 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..cf523af95c --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_delete.md @@ -0,0 +1,60 @@ +--- +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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + 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..612c927978 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get-default.md @@ -0,0 +1,65 @@ +--- +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] +``` + +### 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-ids select the receivers_ids 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + 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..d0f5364d0e --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_get.md @@ -0,0 +1,65 @@ +--- +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] +``` + +### 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-ids select the receivers_ids 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + 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..2df1f54ad0 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_list.md @@ -0,0 +1,68 @@ +--- +title: "ttn-lw-cli alert-notification-profiles list" +slug: ttn-lw-cli_alert-notification-profiles_list +--- + +## ttn-lw-cli alert-notification-profiles list + +List alert notification profiles (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-profiles list [flags] +``` + +### 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-ids select the receivers_ids 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + 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..2b7c69d47d --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-profiles_update.md @@ -0,0 +1,67 @@ +--- +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] +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-profiles]({{< relref "ttn-lw-cli_alert-notification-profiles" >}}) - Alert Notification Profile commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md new file mode 100644 index 0000000000..e450c3d696 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers.md @@ -0,0 +1,61 @@ +--- +title: "ttn-lw-cli alert-notification-receivers" +slug: ttn-lw-cli_alert-notification-receivers +--- + +## ttn-lw-cli alert-notification-receivers + +Alert Notification Receiver commands (EXPERIMENTAL) + +### Options + +``` + -h, --help help for alert-notification-receivers +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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-receivers create]({{< relref "ttn-lw-cli_alert-notification-receivers_create" >}}) - Create an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers delete]({{< relref "ttn-lw-cli_alert-notification-receivers_delete" >}}) - Delete an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers get]({{< relref "ttn-lw-cli_alert-notification-receivers_get" >}}) - Get an alert notification receiver (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers list]({{< relref "ttn-lw-cli_alert-notification-receivers_list" >}}) - List alert notification receivers (EXPERIMENTAL) +* [ttn-lw-cli alert-notification-receivers update]({{< relref "ttn-lw-cli_alert-notification-receivers_update" >}}) - Update an alert notification receiver (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md new file mode 100644 index 0000000000..45107a2f8b --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_create.md @@ -0,0 +1,67 @@ +--- +title: "ttn-lw-cli alert-notification-receivers create" +slug: ttn-lw-cli_alert-notification-receivers_create +--- + +## ttn-lw-cli alert-notification-receivers create + +Create an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers create [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email.recipient string + --contact-method.sms.phone-number string + --contact-method.webhook.headers stringToString + --contact-method.webhook.url string + -h, --help help for create + --ids.receiver-id string + --name string + --receiver-id string +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md new file mode 100644 index 0000000000..f0805b7c63 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_delete.md @@ -0,0 +1,60 @@ +--- +title: "ttn-lw-cli alert-notification-receivers delete" +slug: ttn-lw-cli_alert-notification-receivers_delete +--- + +## ttn-lw-cli alert-notification-receivers delete + +Delete an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers delete [receiver-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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md new file mode 100644 index 0000000000..0a9d6f152d --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_get.md @@ -0,0 +1,69 @@ +--- +title: "ttn-lw-cli alert-notification-receivers get" +slug: ttn-lw-cli_alert-notification-receivers_get +--- + +## ttn-lw-cli alert-notification-receivers get + +Get an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers get [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email select the contact_method.email field and all allowed sub-fields + --contact-method.email.recipient select the contact_method.email.recipient field + --contact-method.sms select the contact_method.sms field and all allowed sub-fields + --contact-method.sms.phone-number select the contact_method.sms.phone_number field + --contact-method.webhook select the contact_method.webhook field and all allowed sub-fields + --contact-method.webhook.headers select the contact_method.webhook.headers field + --contact-method.webhook.url select the contact_method.webhook.url field + -h, --help help for get + --name select the name field + --receiver-id select the receiver_id 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md new file mode 100644 index 0000000000..178b8565df --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_list.md @@ -0,0 +1,72 @@ +--- +title: "ttn-lw-cli alert-notification-receivers list" +slug: ttn-lw-cli_alert-notification-receivers_list +--- + +## ttn-lw-cli alert-notification-receivers list + +List alert notification receivers (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers list [flags] +``` + +### Options + +``` + --contact-method.email select the contact_method.email field and all allowed sub-fields + --contact-method.email.recipient select the contact_method.email.recipient field + --contact-method.sms select the contact_method.sms field and all allowed sub-fields + --contact-method.sms.phone-number select the contact_method.sms.phone_number field + --contact-method.webhook select the contact_method.webhook field and all allowed sub-fields + --contact-method.webhook.headers select the contact_method.webhook.headers field + --contact-method.webhook.url select the contact_method.webhook.url field + -h, --help help for list + --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) + --receiver-id select the receiver_id 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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md new file mode 100644 index 0000000000..e293b4617a --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_alert-notification-receivers_update.md @@ -0,0 +1,68 @@ +--- +title: "ttn-lw-cli alert-notification-receivers update" +slug: ttn-lw-cli_alert-notification-receivers_update +--- + +## ttn-lw-cli alert-notification-receivers update + +Update an alert notification receiver (EXPERIMENTAL) + +``` +ttn-lw-cli alert-notification-receivers update [receiver-id] [flags] +``` + +### Options + +``` + --contact-method.email.recipient string + --contact-method.sms.phone-number string + --contact-method.webhook.headers stringToString + --contact-method.webhook.url string + -h, --help help for update + --ids.receiver-id string + --name string + --receiver-id string + --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/.ttn-lw-cli.yml,$HOME/.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 alert-notification-receivers]({{< relref "ttn-lw-cli_alert-notification-receivers" >}}) - Alert Notification Receiver commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications.md index d27fc2699a..82d36aecfc 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_applications.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_applications.md @@ -56,7 +56,6 @@ Application commands * [ttn-lw-cli applications activation-settings]({{< relref "ttn-lw-cli_applications_activation-settings" >}}) - Application activation settings commands * [ttn-lw-cli applications api-keys]({{< relref "ttn-lw-cli_applications_api-keys" >}}) - Manage application API keys * [ttn-lw-cli applications collaborators]({{< relref "ttn-lw-cli_applications_collaborators" >}}) - Manage application collaborators -* [ttn-lw-cli applications contact-info]({{< relref "ttn-lw-cli_applications_contact-info" >}}) - Manage application contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of application) * [ttn-lw-cli applications create]({{< relref "ttn-lw-cli_applications_create" >}}) - Create an application * [ttn-lw-cli applications delete]({{< relref "ttn-lw-cli_applications_delete" >}}) - Delete an application * [ttn-lw-cli applications get]({{< relref "ttn-lw-cli_applications_get" >}}) - Get an application diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_clients.md b/doc/content/ttn-lw-cli/ttn-lw-cli_clients.md index c206cc9df8..ab091fcfcd 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_clients.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_clients.md @@ -54,7 +54,6 @@ Client commands * [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface * [ttn-lw-cli clients collaborators]({{< relref "ttn-lw-cli_clients_collaborators" >}}) - Manage client collaborators -* [ttn-lw-cli clients contact-info]({{< relref "ttn-lw-cli_clients_contact-info" >}}) - Manage client contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of client) * [ttn-lw-cli clients create]({{< relref "ttn-lw-cli_clients_create" >}}) - Create a client * [ttn-lw-cli clients delete]({{< relref "ttn-lw-cli_clients_delete" >}}) - Delete a client * [ttn-lw-cli clients get]({{< relref "ttn-lw-cli_clients_get" >}}) - Get a client diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways.md index 432f46adfd..739651679c 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways.md @@ -57,7 +57,6 @@ Gateway commands * [ttn-lw-cli gateways batch-delete]({{< relref "ttn-lw-cli_gateways_batch-delete" >}}) - Delete a batch of gateways (EXPERIMENTAL). * [ttn-lw-cli gateways claim]({{< relref "ttn-lw-cli_gateways_claim" >}}) - Claim a gateway (EXPERIMENTAL) * [ttn-lw-cli gateways collaborators]({{< relref "ttn-lw-cli_gateways_collaborators" >}}) - Manage gateway collaborators -* [ttn-lw-cli gateways contact-info]({{< relref "ttn-lw-cli_gateways_contact-info" >}}) - Manage gateway contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of gateway) * [ttn-lw-cli gateways create]({{< relref "ttn-lw-cli_gateways_create" >}}) - Create a gateway * [ttn-lw-cli gateways delete]({{< relref "ttn-lw-cli_gateways_delete" >}}) - Delete a gateway * [ttn-lw-cli gateways get]({{< relref "ttn-lw-cli_gateways_get" >}}) - Get a gateway diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md index 5037afb37b..7617d9285d 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_create.md @@ -16,6 +16,7 @@ ttn-lw-cli gateways create [gateway-id] [flags] ``` --administrative-contact.ids.organization-ids.organization-id string --administrative-contact.ids.user-ids.user-id string + --alert-notification-profile-ids.profile-id string --antenna.attributes stringToString --antenna.gain float32 --antenna.location.accuracy int32 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md index 13a31f8899..0bccb95370 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_get.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways get [gateway-id] [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md index 3a245d34cc..fe52e1648f 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways list [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md index 9fc657c3d1..d8e274438b 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_search.md @@ -19,6 +19,8 @@ ttn-lw-cli gateways search [flags] --administrative-contact.ids.organization-ids.organization-id select the administrative_contact.ids.organization_ids.organization_id field --administrative-contact.ids.user-ids select the administrative_contact.ids.user_ids field and all allowed sub-fields --administrative-contact.ids.user-ids.user-id select the administrative_contact.ids.user_ids.user_id field + --alert-notification-profile-ids select the alert_notification_profile_ids field and all allowed sub-fields + --alert-notification-profile-ids.profile-id select the alert_notification_profile_ids.profile_id field --all select all gateway fields --antennas select the antennas field --attributes select the attributes field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md index bf2feaa103..164a8cd85b 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_set.md @@ -16,6 +16,7 @@ ttn-lw-cli gateways set [gateway-id] [flags] ``` --administrative-contact.ids.organization-ids.organization-id string --administrative-contact.ids.user-ids.user-id string + --alert-notification-profile-ids.profile-id string --antenna.add add an extra antenna --antenna.attributes stringToString --antenna.gain float32 diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations.md index 533b59e0da..1649a35fc4 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations.md @@ -55,7 +55,6 @@ Organization commands * [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface * [ttn-lw-cli organizations api-keys]({{< relref "ttn-lw-cli_organizations_api-keys" >}}) - Manage organization API keys * [ttn-lw-cli organizations collaborators]({{< relref "ttn-lw-cli_organizations_collaborators" >}}) - Manage organization collaborators -* [ttn-lw-cli organizations contact-info]({{< relref "ttn-lw-cli_organizations_contact-info" >}}) - Manage organization contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of organization) * [ttn-lw-cli organizations create]({{< relref "ttn-lw-cli_organizations_create" >}}) - Create an organization * [ttn-lw-cli organizations delete]({{< relref "ttn-lw-cli_organizations_delete" >}}) - Delete an organization * [ttn-lw-cli organizations get]({{< relref "ttn-lw-cli_organizations_get" >}}) - Get an organization diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_create.md index 0eb326a0dd..fc08da3424 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_create.md @@ -20,6 +20,7 @@ ttn-lw-cli organizations create [organization-id] [flags] --attributes stringToString --client-limit uint --description string + --fanout-notifications --gateway-limit uint -h, --help help for create --name string diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_get.md index 41390c4949..f15149ae67 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_get.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_get.md @@ -26,6 +26,7 @@ ttn-lw-cli organizations get [organization-id] [flags] --contact-info select the contact_info field --deleted-at select the deleted_at field --description select the description field + --fanout-notifications select the fanout_notifications field --gateway-limit select the gateway_limit field -h, --help help for get --name select the name field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_list.md index 9fe0956cc3..7b0d1aa040 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_list.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_list.md @@ -27,6 +27,7 @@ ttn-lw-cli organizations list [flags] --deleted --deleted-at select the deleted_at field --description select the description field + --fanout-notifications select the fanout_notifications field --field-mask strings --gateway-limit select the gateway_limit field -h, --help help for list diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_search.md index aa18545c73..4cd1d37d4b 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_search.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_search.md @@ -29,6 +29,7 @@ ttn-lw-cli organizations search [flags] --deleted-at select the deleted_at field --description select the description field --description-contains string + --fanout-notifications select the fanout_notifications field --field-mask strings --gateway-limit select the gateway_limit field -h, --help help for search diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_set.md index 980f9a6c72..0d3253975e 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_set.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_organizations_set.md @@ -20,6 +20,7 @@ ttn-lw-cli organizations set [organization-id] [flags] --attributes stringToString --client-limit uint --description string + --fanout-notifications --gateway-limit uint -h, --help help for set --name string diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays.md new file mode 100644 index 0000000000..a7429a44a5 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays.md @@ -0,0 +1,61 @@ +--- +title: "ttn-lw-cli relays" +slug: ttn-lw-cli_relays +--- + +## ttn-lw-cli relays + +Relay commands (EXPERIMENTAL) + +### Options + +``` + -h, --help help for relays +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays create]({{< relref "ttn-lw-cli_relays_create" >}}) - Create a relay (EXPERIMENTAL) +* [ttn-lw-cli relays delete]({{< relref "ttn-lw-cli_relays_delete" >}}) - Delete a relay (EXPERIMENTAL) +* [ttn-lw-cli relays get]({{< relref "ttn-lw-cli_relays_get" >}}) - Get a relay (EXPERIMENTAL) +* [ttn-lw-cli relays update]({{< relref "ttn-lw-cli_relays_update" >}}) - Update a relay (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_create.md new file mode 100644 index 0000000000..9334bdd29f --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_create.md @@ -0,0 +1,86 @@ +--- +title: "ttn-lw-cli relays create" +slug: ttn-lw-cli_relays_create +--- + +## ttn-lw-cli relays create + +Create a relay (EXPERIMENTAL) + +``` +ttn-lw-cli relays create [application-id] [device-id] [flags] +``` + +### Options + +``` + -h, --help help for create + --mode.served + --mode.served.backoff uint32 + --mode.served.mode.always + --mode.served.mode.dynamic + --mode.served.mode.dynamic.smart-enable-level string allowed values: RELAY_SMART_ENABLE_LEVEL_8, RELAY_SMART_ENABLE_LEVEL_16, RELAY_SMART_ENABLE_LEVEL_32, RELAY_SMART_ENABLE_LEVEL_64 + --mode.served.mode.end-device-controlled + --mode.served.second-channel + --mode.served.second-channel.ack-offset string allowed values: RELAY_SECOND_CH_ACK_OFFSET_0, RELAY_SECOND_CH_ACK_OFFSET_200, RELAY_SECOND_CH_ACK_OFFSET_400, RELAY_SECOND_CH_ACK_OFFSET_800, RELAY_SECOND_CH_ACK_OFFSET_1600, RELAY_SECOND_CH_ACK_OFFSET_3200 + --mode.served.second-channel.data-rate-index string allowed values: 0, DATA_RATE_0, 1, DATA_RATE_1, 2, DATA_RATE_2, 3, DATA_RATE_3, 4, DATA_RATE_4, 5, DATA_RATE_5, 6, DATA_RATE_6, 7, DATA_RATE_7, 8, DATA_RATE_8, 9, DATA_RATE_9, 10, DATA_RATE_10, 11, DATA_RATE_11, 12, DATA_RATE_12, 13, DATA_RATE_13, 14, DATA_RATE_14, 15, DATA_RATE_15 + --mode.served.second-channel.frequency uint + --mode.served.serving-device-id string + --mode.serving + --mode.serving.cad-periodicity string allowed values: RELAY_CAD_PERIODICITY_1_SECOND, RELAY_CAD_PERIODICITY_500_MILLISECONDS, RELAY_CAD_PERIODICITY_250_MILLISECONDS, RELAY_CAD_PERIODICITY_100_MILLISECONDS, RELAY_CAD_PERIODICITY_50_MILLISECONDS, RELAY_CAD_PERIODICITY_20_MILLISECONDS + --mode.serving.default-channel-index uint32 + --mode.serving.limits.join-requests.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.join-requests.reload-rate uint32 + --mode.serving.limits.notifications.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.notifications.reload-rate uint32 + --mode.serving.limits.overall.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.overall.reload-rate uint32 + --mode.serving.limits.reset-behavior string allowed values: RELAY_RESET_LIMIT_COUNTER_ZERO, RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE, RELAY_RESET_LIMIT_COUNTER_MAX_VALUE, RELAY_RESET_LIMIT_COUNTER_NO_RESET + --mode.serving.limits.uplink-messages.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.uplink-messages.reload-rate uint32 + --mode.serving.second-channel.ack-offset string allowed values: RELAY_SECOND_CH_ACK_OFFSET_0, RELAY_SECOND_CH_ACK_OFFSET_200, RELAY_SECOND_CH_ACK_OFFSET_400, RELAY_SECOND_CH_ACK_OFFSET_800, RELAY_SECOND_CH_ACK_OFFSET_1600, RELAY_SECOND_CH_ACK_OFFSET_3200 + --mode.serving.second-channel.data-rate-index string allowed values: 0, DATA_RATE_0, 1, DATA_RATE_1, 2, DATA_RATE_2, 3, DATA_RATE_3, 4, DATA_RATE_4, 5, DATA_RATE_5, 6, DATA_RATE_6, 7, DATA_RATE_7, 8, DATA_RATE_8, 9, DATA_RATE_9, 10, DATA_RATE_10, 11, DATA_RATE_11, 12, DATA_RATE_12, 13, DATA_RATE_13, 14, DATA_RATE_14, 15, DATA_RATE_15 + --mode.serving.second-channel.frequency uint +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_delete.md new file mode 100644 index 0000000000..5a124386d4 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_delete.md @@ -0,0 +1,60 @@ +--- +title: "ttn-lw-cli relays delete" +slug: ttn-lw-cli_relays_delete +--- + +## ttn-lw-cli relays delete + +Delete a relay (EXPERIMENTAL) + +``` +ttn-lw-cli relays delete [application-id] [device-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/.ttn-lw-cli.yml,$HOME/.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 relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_get.md new file mode 100644 index 0000000000..ff0a340233 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_get.md @@ -0,0 +1,93 @@ +--- +title: "ttn-lw-cli relays get" +slug: ttn-lw-cli_relays_get +--- + +## ttn-lw-cli relays get + +Get a relay (EXPERIMENTAL) + +``` +ttn-lw-cli relays get [application-id] [device-id] [flags] +``` + +### Options + +``` + -h, --help help for get + --mode.served select the mode.served field and all allowed sub-fields + --mode.served.backoff select the mode.served.backoff field + --mode.served.mode.always select the mode.served.mode.always field and all allowed sub-fields + --mode.served.mode.dynamic select the mode.served.mode.dynamic field and all allowed sub-fields + --mode.served.mode.dynamic.smart-enable-level select the mode.served.mode.dynamic.smart_enable_level field + --mode.served.mode.end-device-controlled select the mode.served.mode.end_device_controlled field and all allowed sub-fields + --mode.served.second-channel select the mode.served.second_channel field and all allowed sub-fields + --mode.served.second-channel.ack-offset select the mode.served.second_channel.ack_offset field + --mode.served.second-channel.data-rate-index select the mode.served.second_channel.data_rate_index field + --mode.served.second-channel.frequency select the mode.served.second_channel.frequency field + --mode.served.serving-device-id select the mode.served.serving_device_id field + --mode.serving select the mode.serving field and all allowed sub-fields + --mode.serving.cad-periodicity select the mode.serving.cad_periodicity field + --mode.serving.default-channel-index select the mode.serving.default_channel_index field + --mode.serving.limits select the mode.serving.limits field and all allowed sub-fields + --mode.serving.limits.join-requests select the mode.serving.limits.join_requests field and all allowed sub-fields + --mode.serving.limits.join-requests.bucket-size select the mode.serving.limits.join_requests.bucket_size field + --mode.serving.limits.join-requests.reload-rate select the mode.serving.limits.join_requests.reload_rate field + --mode.serving.limits.notifications select the mode.serving.limits.notifications field and all allowed sub-fields + --mode.serving.limits.notifications.bucket-size select the mode.serving.limits.notifications.bucket_size field + --mode.serving.limits.notifications.reload-rate select the mode.serving.limits.notifications.reload_rate field + --mode.serving.limits.overall select the mode.serving.limits.overall field and all allowed sub-fields + --mode.serving.limits.overall.bucket-size select the mode.serving.limits.overall.bucket_size field + --mode.serving.limits.overall.reload-rate select the mode.serving.limits.overall.reload_rate field + --mode.serving.limits.reset-behavior select the mode.serving.limits.reset_behavior field + --mode.serving.limits.uplink-messages select the mode.serving.limits.uplink_messages field and all allowed sub-fields + --mode.serving.limits.uplink-messages.bucket-size select the mode.serving.limits.uplink_messages.bucket_size field + --mode.serving.limits.uplink-messages.reload-rate select the mode.serving.limits.uplink_messages.reload_rate field + --mode.serving.second-channel select the mode.serving.second_channel field and all allowed sub-fields + --mode.serving.second-channel.ack-offset select the mode.serving.second_channel.ack_offset field + --mode.serving.second-channel.data-rate-index select the mode.serving.second_channel.data_rate_index field + --mode.serving.second-channel.frequency select the mode.serving.second_channel.frequency field + --mode.serving.uplink-forwarding-rules select the mode.serving.uplink_forwarding_rules 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/.ttn-lw-cli.yml,$HOME/.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 relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_update.md new file mode 100644 index 0000000000..e0b3e9591f --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_update.md @@ -0,0 +1,86 @@ +--- +title: "ttn-lw-cli relays update" +slug: ttn-lw-cli_relays_update +--- + +## ttn-lw-cli relays update + +Update a relay (EXPERIMENTAL) + +``` +ttn-lw-cli relays update [application-id] [device-id] [flags] +``` + +### Options + +``` + -h, --help help for update + --mode.served + --mode.served.backoff uint32 + --mode.served.mode.always + --mode.served.mode.dynamic + --mode.served.mode.dynamic.smart-enable-level string allowed values: RELAY_SMART_ENABLE_LEVEL_8, RELAY_SMART_ENABLE_LEVEL_16, RELAY_SMART_ENABLE_LEVEL_32, RELAY_SMART_ENABLE_LEVEL_64 + --mode.served.mode.end-device-controlled + --mode.served.second-channel + --mode.served.second-channel.ack-offset string allowed values: RELAY_SECOND_CH_ACK_OFFSET_0, RELAY_SECOND_CH_ACK_OFFSET_200, RELAY_SECOND_CH_ACK_OFFSET_400, RELAY_SECOND_CH_ACK_OFFSET_800, RELAY_SECOND_CH_ACK_OFFSET_1600, RELAY_SECOND_CH_ACK_OFFSET_3200 + --mode.served.second-channel.data-rate-index string allowed values: 0, DATA_RATE_0, 1, DATA_RATE_1, 2, DATA_RATE_2, 3, DATA_RATE_3, 4, DATA_RATE_4, 5, DATA_RATE_5, 6, DATA_RATE_6, 7, DATA_RATE_7, 8, DATA_RATE_8, 9, DATA_RATE_9, 10, DATA_RATE_10, 11, DATA_RATE_11, 12, DATA_RATE_12, 13, DATA_RATE_13, 14, DATA_RATE_14, 15, DATA_RATE_15 + --mode.served.second-channel.frequency uint + --mode.served.serving-device-id string + --mode.serving + --mode.serving.cad-periodicity string allowed values: RELAY_CAD_PERIODICITY_1_SECOND, RELAY_CAD_PERIODICITY_500_MILLISECONDS, RELAY_CAD_PERIODICITY_250_MILLISECONDS, RELAY_CAD_PERIODICITY_100_MILLISECONDS, RELAY_CAD_PERIODICITY_50_MILLISECONDS, RELAY_CAD_PERIODICITY_20_MILLISECONDS + --mode.serving.default-channel-index uint32 + --mode.serving.limits.join-requests.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.join-requests.reload-rate uint32 + --mode.serving.limits.notifications.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.notifications.reload-rate uint32 + --mode.serving.limits.overall.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.overall.reload-rate uint32 + --mode.serving.limits.reset-behavior string allowed values: RELAY_RESET_LIMIT_COUNTER_ZERO, RELAY_RESET_LIMIT_COUNTER_RELOAD_RATE, RELAY_RESET_LIMIT_COUNTER_MAX_VALUE, RELAY_RESET_LIMIT_COUNTER_NO_RESET + --mode.serving.limits.uplink-messages.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --mode.serving.limits.uplink-messages.reload-rate uint32 + --mode.serving.second-channel.ack-offset string allowed values: RELAY_SECOND_CH_ACK_OFFSET_0, RELAY_SECOND_CH_ACK_OFFSET_200, RELAY_SECOND_CH_ACK_OFFSET_400, RELAY_SECOND_CH_ACK_OFFSET_800, RELAY_SECOND_CH_ACK_OFFSET_1600, RELAY_SECOND_CH_ACK_OFFSET_3200 + --mode.serving.second-channel.data-rate-index string allowed values: 0, DATA_RATE_0, 1, DATA_RATE_1, 2, DATA_RATE_2, 3, DATA_RATE_3, 4, DATA_RATE_4, 5, DATA_RATE_5, 6, DATA_RATE_6, 7, DATA_RATE_7, 8, DATA_RATE_8, 9, DATA_RATE_9, 10, DATA_RATE_10, 11, DATA_RATE_11, 12, DATA_RATE_12, 13, DATA_RATE_13, 14, DATA_RATE_14, 15, DATA_RATE_15 + --mode.serving.second-channel.frequency uint +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules.md new file mode 100644 index 0000000000..9ebc75c9d4 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules.md @@ -0,0 +1,61 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules" +slug: ttn-lw-cli_relays_uplink-forwarding-rules +--- + +## ttn-lw-cli relays uplink-forwarding-rules + +Uplink forwarding rules commands (EXPERIMENTAL) + +### Options + +``` + -h, --help help for uplink-forwarding-rules +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays]({{< relref "ttn-lw-cli_relays" >}}) - Relay commands (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules create]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules_create" >}}) - Create an uplink forwarding rule (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules delete]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules_delete" >}}) - Delete an uplink forwarding rule (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules get]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules_get" >}}) - Get an uplink forwarding rule (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules list]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules_list" >}}) - List uplink forwarding rules (EXPERIMENTAL) +* [ttn-lw-cli relays uplink-forwarding-rules update]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules_update" >}}) - Update an uplink forwarding rule (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_create.md new file mode 100644 index 0000000000..ad0ba44836 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_create.md @@ -0,0 +1,65 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules create" +slug: ttn-lw-cli_relays_uplink-forwarding-rules_create +--- + +## ttn-lw-cli relays uplink-forwarding-rules create + +Create an uplink forwarding rule (EXPERIMENTAL) + +``` +ttn-lw-cli relays uplink-forwarding-rules create [application-id] [device-id] [index] [flags] +``` + +### Options + +``` + --device-id string + -h, --help help for create + --last-w-f-cnt uint32 + --limits.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --limits.reload-rate uint32 + --session-key-id bytesBase64 +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_delete.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_delete.md new file mode 100644 index 0000000000..80272f7da2 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_delete.md @@ -0,0 +1,60 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules delete" +slug: ttn-lw-cli_relays_uplink-forwarding-rules_delete +--- + +## ttn-lw-cli relays uplink-forwarding-rules delete + +Delete an uplink forwarding rule (EXPERIMENTAL) + +``` +ttn-lw-cli relays uplink-forwarding-rules delete [application-id] [device-id] [index] [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/.ttn-lw-cli.yml,$HOME/.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 relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_get.md new file mode 100644 index 0000000000..475b3d50f1 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_get.md @@ -0,0 +1,66 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules get" +slug: ttn-lw-cli_relays_uplink-forwarding-rules_get +--- + +## ttn-lw-cli relays uplink-forwarding-rules get + +Get an uplink forwarding rule (EXPERIMENTAL) + +``` +ttn-lw-cli relays uplink-forwarding-rules get [application-id] [device-id] [index] [flags] +``` + +### Options + +``` + --device-id select the device_id field + -h, --help help for get + --last-w-f-cnt select the last_w_f_cnt field + --limits select the limits field and all allowed sub-fields + --limits.bucket-size select the limits.bucket_size field + --limits.reload-rate select the limits.reload_rate field + --session-key-id select the session_key_id 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/.ttn-lw-cli.yml,$HOME/.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 relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_list.md new file mode 100644 index 0000000000..c552204f79 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_list.md @@ -0,0 +1,66 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules list" +slug: ttn-lw-cli_relays_uplink-forwarding-rules_list +--- + +## ttn-lw-cli relays uplink-forwarding-rules list + +List uplink forwarding rules (EXPERIMENTAL) + +``` +ttn-lw-cli relays uplink-forwarding-rules list [application-id] [device-id] [flags] +``` + +### Options + +``` + --device-id select the device_id field + -h, --help help for list + --last-w-f-cnt select the last_w_f_cnt field + --limits select the limits field and all allowed sub-fields + --limits.bucket-size select the limits.bucket_size field + --limits.reload-rate select the limits.reload_rate field + --session-key-id select the session_key_id 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/.ttn-lw-cli.yml,$HOME/.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 relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_update.md new file mode 100644 index 0000000000..c89a19f923 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_relays_uplink-forwarding-rules_update.md @@ -0,0 +1,65 @@ +--- +title: "ttn-lw-cli relays uplink-forwarding-rules update" +slug: ttn-lw-cli_relays_uplink-forwarding-rules_update +--- + +## ttn-lw-cli relays uplink-forwarding-rules update + +Update an uplink forwarding rule (EXPERIMENTAL) + +``` +ttn-lw-cli relays uplink-forwarding-rules update [application-id] [device-id] [index] [flags] +``` + +### Options + +``` + --device-id string + -h, --help help for update + --last-w-f-cnt uint32 + --limits.bucket-size string allowed values: RELAY_LIMIT_BUCKET_SIZE_1, RELAY_LIMIT_BUCKET_SIZE_2, RELAY_LIMIT_BUCKET_SIZE_4, RELAY_LIMIT_BUCKET_SIZE_12 + --limits.reload-rate uint32 + --session-key-id bytesBase64 +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 relays uplink-forwarding-rules]({{< relref "ttn-lw-cli_relays_uplink-forwarding-rules" >}}) - Uplink forwarding rules commands (EXPERIMENTAL) + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md index 26fc33de1b..2f31a9a26f 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md @@ -23,6 +23,7 @@ ttn-lw-cli tenants create [tenant-id] [flags] --billing.provider.stripe.plan-id string --billing.provider.stripe.subscription-id string --billing.provider.stripe.subscription-item-id string + --configuration.default-cluster.ars.routing.enabled --configuration.default-cluster.is.admin-rights.all --configuration.default-cluster.is.email.network.branding-base-url string --configuration.default-cluster.is.end-device-picture.disable-upload diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md index 8b2f78bc52..1c91a87021 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md @@ -32,6 +32,9 @@ ttn-lw-cli tenants get [tenant-id] [flags] --configuration select the configuration field and all allowed sub-fields --configuration.clusters select the configuration.clusters field --configuration.default-cluster select the configuration.default_cluster field and all allowed sub-fields + --configuration.default-cluster.ars select the configuration.default_cluster.ars field and all allowed sub-fields + --configuration.default-cluster.ars.routing select the configuration.default_cluster.ars.routing field and all allowed sub-fields + --configuration.default-cluster.ars.routing.enabled select the configuration.default_cluster.ars.routing.enabled field --configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields --configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields --configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_list.md index 4b99226038..e5d7592f32 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_list.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_list.md @@ -32,6 +32,9 @@ ttn-lw-cli tenants list [flags] --configuration select the configuration field and all allowed sub-fields --configuration.clusters select the configuration.clusters field --configuration.default-cluster select the configuration.default_cluster field and all allowed sub-fields + --configuration.default-cluster.ars select the configuration.default_cluster.ars field and all allowed sub-fields + --configuration.default-cluster.ars.routing select the configuration.default_cluster.ars.routing field and all allowed sub-fields + --configuration.default-cluster.ars.routing.enabled select the configuration.default_cluster.ars.routing.enabled field --configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields --configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields --configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_search.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_search.md index 817101ff8e..8f8eb8a6cd 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_search.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_search.md @@ -33,6 +33,9 @@ ttn-lw-cli tenants search [flags] --configuration select the configuration field and all allowed sub-fields --configuration.clusters select the configuration.clusters field --configuration.default-cluster select the configuration.default_cluster field and all allowed sub-fields + --configuration.default-cluster.ars select the configuration.default_cluster.ars field and all allowed sub-fields + --configuration.default-cluster.ars.routing select the configuration.default_cluster.ars.routing field and all allowed sub-fields + --configuration.default-cluster.ars.routing.enabled select the configuration.default_cluster.ars.routing.enabled field --configuration.default-cluster.is select the configuration.default_cluster.is field and all allowed sub-fields --configuration.default-cluster.is.admin-rights select the configuration.default_cluster.is.admin_rights field and all allowed sub-fields --configuration.default-cluster.is.admin-rights.all select the configuration.default_cluster.is.admin_rights.all field diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_update.md b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_update.md index 0678b8d559..1ba09770fe 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_update.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_tenants_update.md @@ -23,6 +23,7 @@ ttn-lw-cli tenants update [tenant-id] [flags] --billing.provider.stripe.plan-id string --billing.provider.stripe.subscription-id string --billing.provider.stripe.subscription-item-id string + --configuration.default-cluster.ars.routing.enabled --configuration.default-cluster.is.admin-rights.all --configuration.default-cluster.is.email.network.branding-base-url string --configuration.default-cluster.is.end-device-picture.disable-upload diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users.md index 7d46d7c409..f141a5a600 100644 --- a/doc/content/ttn-lw-cli/ttn-lw-cli_users.md +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users.md @@ -54,10 +54,10 @@ User commands * [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface * [ttn-lw-cli users api-keys]({{< relref "ttn-lw-cli_users_api-keys" >}}) - Manage user API keys -* [ttn-lw-cli users contact-info]({{< relref "ttn-lw-cli_users_contact-info" >}}) - Manage user contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of user) * [ttn-lw-cli users create]({{< relref "ttn-lw-cli_users_create" >}}) - Create a user * [ttn-lw-cli users create-login-token]({{< relref "ttn-lw-cli_users_create-login-token" >}}) - Create a user login token * [ttn-lw-cli users delete]({{< relref "ttn-lw-cli_users_delete" >}}) - Delete a user +* [ttn-lw-cli users email-validations]({{< relref "ttn-lw-cli_users_email-validations" >}}) - Email validations commands * [ttn-lw-cli users forgot-password]({{< relref "ttn-lw-cli_users_forgot-password" >}}) - Request a temporary user password * [ttn-lw-cli users get]({{< relref "ttn-lw-cli_users_get" >}}) - Get a user * [ttn-lw-cli users invitations]({{< relref "ttn-lw-cli_users_invitations" >}}) - Manage user invitations diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations.md new file mode 100644 index 0000000000..9d16a344a3 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations.md @@ -0,0 +1,58 @@ +--- +title: "ttn-lw-cli users email-validations" +slug: ttn-lw-cli_users_email-validations +--- + +## ttn-lw-cli users email-validations + +Email validations commands + +### Options + +``` + -h, --help help for email-validations +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 users]({{< relref "ttn-lw-cli_users" >}}) - User commands +* [ttn-lw-cli users email-validations request]({{< relref "ttn-lw-cli_users_email-validations_request" >}}) - Request validation for an user's email address +* [ttn-lw-cli users email-validations validate]({{< relref "ttn-lw-cli_users_email-validations_validate" >}}) - Validate an user's email address + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_request.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_request.md new file mode 100644 index 0000000000..603bb96a0c --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_request.md @@ -0,0 +1,61 @@ +--- +title: "ttn-lw-cli users email-validations request" +slug: ttn-lw-cli_users_email-validations_request +--- + +## ttn-lw-cli users email-validations request + +Request validation for an user's email address + +``` +ttn-lw-cli users email-validations request [user-id] [flags] +``` + +### Options + +``` + -h, --help help for request + --user-id string +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 users email-validations]({{< relref "ttn-lw-cli_users_email-validations" >}}) - Email validations commands + diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_validate.md b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_validate.md new file mode 100644 index 0000000000..1da2f85877 --- /dev/null +++ b/doc/content/ttn-lw-cli/ttn-lw-cli_users_email-validations_validate.md @@ -0,0 +1,62 @@ +--- +title: "ttn-lw-cli users email-validations validate" +slug: ttn-lw-cli_users_email-validations_validate +--- + +## ttn-lw-cli users email-validations validate + +Validate an user's email address + +``` +ttn-lw-cli users email-validations validate [reference] [token] [flags] +``` + +### Options + +``` + -h, --help help for validate + --reference string Reference of the requested validation + --token string Token that you received +``` + +### 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/.ttn-lw-cli.yml,$HOME/.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 users email-validations]({{< relref "ttn-lw-cli_users_email-validations" >}}) - Email validations commands + diff --git a/doc/content/whats-new/3.29.0.md b/doc/content/whats-new/3.29.0.md new file mode 100644 index 0000000000..d68f81dbdd --- /dev/null +++ b/doc/content/whats-new/3.29.0.md @@ -0,0 +1,33 @@ +--- +date: 2024-02-06 +title: "3.29.0" +featured: { + added: ['CLI command (`relays`) to enable LoRaWAN relays management.'], + changed: ['Organizations can now opt out from sending administrative and technical notifications to all collaborators.'], + removed: ['`http.client.transport.compression` and `http.server.transport.compression` experimental flags.'], + fixed: ['Adding collaborator form not validating collaborator on submit in the Console.'] +} +--- + +### Added + +- `relays` command to `ttn-lw-cli`, which enables the management of LoRaWAN relays, including their configuration and uplink forwarding rules. + +### Changed + +- User's primary email address validation is now decoupled from deprecated `ContactInfo` field. + - This requires a database schema migration (`ttn-lw-stack is-db migrate`) because of the new `email_validations` table. +- Entities' `ContactInfo` field now returns information regarding the administrative and technical contacts instead of the deprecated `ContactInfo` information. + - This requires a database schema migration (`ttn-lw-stack is-db migrate`) due to the removal of old information in the `contact_infos` table. + - The emails of the administrative and technical contacts are only returned in the `ContactInfo` field if the caller has the appropriate rights. +- Organizations can now opt out from sending administrative and technical notifications to all collaborators. + - New organizations do not send administrative and technical notifications to all collaborators by default. + - To alter the behavior update the organization's `fanout_notifications` field. + +### Removed + +- The `http.client.transport.compression` and `http.server.transport.compression` experimental flags. + +### Fixed + +- Fix Add collaborator form not validating collaborator on submit in the Console. diff --git a/doc/data/api/tti.lorawan.v3/enums/AlertStatus.yml b/doc/data/api/tti.lorawan.v3/enums/AlertStatus.yml new file mode 100644 index 0000000000..0a20addfea --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/enums/AlertStatus.yml @@ -0,0 +1,6 @@ +name: AlertStatus +values: +- name: FIRING + value: 0 +- name: RESOLVED + value: 1 diff --git a/doc/data/api/tti.lorawan.v3/enums/AlertType.yml b/doc/data/api/tti.lorawan.v3/enums/AlertType.yml new file mode 100644 index 0000000000..361e8bfe71 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/enums/AlertType.yml @@ -0,0 +1,6 @@ +name: AlertType +values: +- name: ALERT_UNKNOWN + value: 0 +- name: ALERT_GATEWAY_DISCONNECTED + value: 1 diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotification.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotification.yml new file mode 100644 index 0000000000..ef553f7cd4 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotification.yml @@ -0,0 +1,43 @@ +name: AlertNotification +fields: +- name: type + comment: The type of alert generated. + enum: + name: AlertType + rules: + defined_only: true + default: ALERT_UNKNOWN +- name: status + comment: The current status of the alert notification, either "firing" or "resolved". + enum: + name: AlertStatus + rules: + defined_only: true + default: FIRING +- name: entity_ids + comment: Identifiers of the entity that triggered the alert. + message: + package: ttn.lorawan.v3 + name: EntityIdentifiers + default: {} +- name: tenant_ids + comment: Identifiers of the tenant that triggered the alert. + message: + name: TenantIdentifiers + rules: + required: true + default: {} +- name: receiver_ids + comment: Identifiers of the alert's receiver. + message: + name: AlertNotificationReceiverIdentifiers + rules: + required: true + default: {} +- name: labels + comment: Extra labels attached to an Alert + map_key: + type: string + map_value: + type: string + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml new file mode 100644 index 0000000000..39d788b426 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfile.yml @@ -0,0 +1,47 @@ +name: AlertNotificationProfile +fields: +- name: ids + comment: The identifiers of the profile. These are public and can be seen by any + authenticated user in the network. + message: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + rules: + required: true + default: {} +- name: created_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: updated_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: is_default + comment: Whether this profile is the default alert notification profile for the + network. + message: + package: google.protobuf + name: BoolValue + default: null +- name: name + type: string + rules: + max_len: 50 + default: "" +- name: description + type: string + rules: + max_len: 256 + default: "" +- name: receivers_ids + comment: List of receivers that will be notified when an alert is triggered for + this profile. + rules: + max_items: 20 + repeated: + message: + name: AlertNotificationReceiverIdentifiers + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml new file mode 100644 index 0000000000..f6fccfde5c --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationProfiles.yml @@ -0,0 +1,7 @@ +name: AlertNotificationProfiles +fields: +- name: profiles + repeated: + message: + name: AlertNotificationProfile + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml new file mode 100644 index 0000000000..f91bf288be --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Email.yml @@ -0,0 +1,7 @@ +name: AlertNotificationReceiver.Email +fields: +- name: recipient + type: string + rules: + email: true + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml new file mode 100644 index 0000000000..62ac4c3169 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.SMS.yml @@ -0,0 +1,11 @@ +name: AlertNotificationReceiver.SMS +fields: +- name: phone_number + comment: |- + According to the international phone numbering plan (ITU-T E. 164) + phone numbers cannot contain less than 7 digits and more than 15 digits. + The validation is done via an regex and accounts for the '+' formating character. + type: string + rules: + pattern: ^[+]?[0-9]{7,15}$ + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml new file mode 100644 index 0000000000..312e7d7e3b --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.Webhook.yml @@ -0,0 +1,20 @@ +name: AlertNotificationReceiver.Webhook +fields: +- name: url + type: string + rules: + uri: true + default: "" +- name: headers + rules: + max_pairs: 50 + ignore_empty: true + map_key: + type: string + rules: + max_len: 64 + map_value: + type: string + rules: + max_len: 4096 + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml new file mode 100644 index 0000000000..db7e3d2c0f --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiver.yml @@ -0,0 +1,43 @@ +name: AlertNotificationReceiver +fields: +- name: ids + comment: The identifiers of the receiver. These can be seen by any admin user in + the network. + message: + name: AlertNotificationReceiverIdentifiers + rules: + required: true + default: {} +- name: created_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: updated_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: name + type: string + rules: + max_len: 50 + default: "" +- name: email + message: + name: AlertNotificationReceiver.Email + default: {} +- name: sms + message: + name: AlertNotificationReceiver.SMS + default: {} +- name: webhook + message: + name: AlertNotificationReceiver.Webhook + default: {} +oneofs: +- name: contact_method + field_names: + - email + - sms + - webhook diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml new file mode 100644 index 0000000000..9e88cad7fe --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceiverIdentifiers.yml @@ -0,0 +1,8 @@ +name: AlertNotificationReceiverIdentifiers +fields: +- name: receiver_id + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" diff --git a/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml new file mode 100644 index 0000000000..08c42335eb --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/AlertNotificationReceivers.yml @@ -0,0 +1,7 @@ +name: AlertNotificationReceivers +fields: +- name: receivers + repeated: + message: + name: AlertNotificationReceiver + default: [] diff --git a/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.Routing.yml b/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.Routing.yml new file mode 100644 index 0000000000..bac2e3e3e8 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.Routing.yml @@ -0,0 +1,7 @@ +name: ArsConfiguration.Routing +fields: +- name: enabled + message: + package: google.protobuf + name: BoolValue + default: null diff --git a/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.yml b/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.yml new file mode 100644 index 0000000000..c3967f928c --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ArsConfiguration.yml @@ -0,0 +1,6 @@ +name: ArsConfiguration +fields: +- name: routing + message: + name: ArsConfiguration.Routing + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.Routing.yml b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.Routing.yml new file mode 100644 index 0000000000..d9dc38e9dd --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.Routing.yml @@ -0,0 +1,7 @@ +name: Configuration.Cluster.AlertRoutingServer.Routing +fields: +- name: enabled + message: + package: google.protobuf + name: BoolValue + default: null diff --git a/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.yml b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.yml new file mode 100644 index 0000000000..0c8d0477e6 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.AlertRoutingServer.yml @@ -0,0 +1,6 @@ +name: Configuration.Cluster.AlertRoutingServer +fields: +- name: routing + message: + name: Configuration.Cluster.AlertRoutingServer.Routing + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.yml b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.yml index 1354b32ed7..d5b718cd6a 100644 --- a/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.yml +++ b/doc/data/api/tti.lorawan.v3/messages/Configuration.Cluster.yml @@ -23,3 +23,8 @@ fields: message: name: Configuration.Cluster.NetworkOperationsCenter default: {} +- name: ars + comment: Alert Routing Server configuration. + message: + name: Configuration.Cluster.AlertRoutingServer + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..865e98a1b9 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationProfileRequest.yml @@ -0,0 +1,8 @@ +name: CreateAlertNotificationProfileRequest +fields: +- name: profile + message: + name: AlertNotificationProfile + rules: + required: true + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..5936774d27 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/CreateAlertNotificationReceiverRequest.yml @@ -0,0 +1,8 @@ +name: CreateAlertNotificationReceiverRequest +fields: +- name: receiver + message: + name: AlertNotificationReceiver + rules: + required: true + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..893d909532 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationProfileRequest.yml @@ -0,0 +1,14 @@ +name: GetAlertNotificationProfileRequest +fields: +- name: ids + message: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..3a5c4367c4 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetAlertNotificationReceiverRequest.yml @@ -0,0 +1,13 @@ +name: GetAlertNotificationReceiverRequest +fields: +- name: ids + message: + name: AlertNotificationReceiverIdentifiers + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationRequest.yml new file mode 100644 index 0000000000..921ec0f470 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationRequest.yml @@ -0,0 +1 @@ +name: GetArsConfigurationRequest diff --git a/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationResponse.yml b/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationResponse.yml new file mode 100644 index 0000000000..611e14ca41 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetArsConfigurationResponse.yml @@ -0,0 +1,6 @@ +name: GetArsConfigurationResponse +fields: +- name: configuration + message: + name: ArsConfiguration + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..f0e04826da --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/GetDefaultAlertNotificationProfileRequest.yml @@ -0,0 +1,7 @@ +name: GetDefaultAlertNotificationProfileRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml new file mode 100644 index 0000000000..08c3bb7569 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationProfilesRequest.yml @@ -0,0 +1,32 @@ +name: ListAlertNotificationProfilesRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} +- name: order + comment: |- + Order the results by this field path (must be present in the field mask). + Default ordering is by ID. Prepend with a minus (-) to reverse the order. + type: string + rules: + in: + - "" + - profile_id + - -profile_id + - name + - -name + - created_at + - -created_at + default: "" +- name: limit + comment: Limit the number of results per page. + type: uint32 + rules: + lte: 1000 + default: 0 +- name: page + comment: Page number for pagination. 0 is interpreted as 1. + type: uint32 + default: 0 diff --git a/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml new file mode 100644 index 0000000000..f2dd886441 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/ListAlertNotificationReceiversRequest.yml @@ -0,0 +1,32 @@ +name: ListAlertNotificationReceiversRequest +fields: +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} +- name: order + comment: |- + Order the results by this field path (must be present in the field mask). + Default ordering is by ID. Prepend with a minus (-) to reverse the order. + type: string + rules: + in: + - "" + - receiver_id + - -receiver_id + - name + - -name + - created_at + - -created_at + default: "" +- name: limit + comment: Limit the number of results per page. + type: uint32 + rules: + lte: 1000 + default: 0 +- name: page + comment: Page number for pagination. 0 is interpreted as 1. + type: uint32 + default: 0 diff --git a/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml new file mode 100644 index 0000000000..b3a801f0fa --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationProfileRequest.yml @@ -0,0 +1,13 @@ +name: UpdateAlertNotificationProfileRequest +fields: +- name: profile + message: + name: AlertNotificationProfile + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml new file mode 100644 index 0000000000..b657e73fae --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/messages/UpdateAlertNotificationReceiverRequest.yml @@ -0,0 +1,13 @@ +name: UpdateAlertNotificationReceiverRequest +fields: +- name: receiver + message: + name: AlertNotificationReceiver + rules: + required: true + default: {} +- name: field_mask + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml b/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml new file mode 100644 index 0000000000..12aed31bda --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/services/AlertNotificationProfileRegistry.yml @@ -0,0 +1,69 @@ +name: AlertNotificationProfileRegistry +comment: |- + The AlertNotificationProfileRegistry service, exposed by the Identity Server. + Is used to manage alert notification profiles. +methods: + Create: + name: Create + comment: Create a new alert notification profile. + input: + name: CreateAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: POST + path: /alerts/notifications/profiles + Get: + name: Get + comment: Get an existing alert notification profile. + input: + name: GetAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: GET + path: /alerts/notifications/profiles/{ids.profile_id} + List: + name: List + comment: |- + List existing alert notification profiles. Returns all profiles if no identifiers are provided. + If provided, the identifiers are used to filter which profiles are returned. + input: + name: ListAlertNotificationProfilesRequest + output: + name: AlertNotificationProfiles + http: + - method: GET + path: /alerts/notifications/profiles + Update: + name: Update + comment: Update an existing alert notification profile. + input: + name: UpdateAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: PUT + path: /alerts/notifications/profiles/{profile.ids.profile_id} + Delete: + name: Delete + comment: Delete an existing alert notification profile. + input: + package: ttn.lorawan.v3 + name: AlertNotificationProfileIdentifiers + output: + package: google.protobuf + name: Empty + http: + - method: DELETE + path: /alerts/notifications/profiles/{profile_id} + GetDefault: + name: GetDefault + comment: Get the default alert notification profile. + input: + name: GetDefaultAlertNotificationProfileRequest + output: + name: AlertNotificationProfile + http: + - method: GET + path: /alerts/notifications/profiles/default diff --git a/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml b/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml new file mode 100644 index 0000000000..f5880397e9 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/services/AlertNotificationReceiverRegistry.yml @@ -0,0 +1,57 @@ +name: AlertNotificationReceiverRegistry +comment: |- + The AlertNotificationReceiverRegistry service, exposed by the Identity Server. + Is used to manage alert notification receivers. +methods: + Create: + name: Create + comment: Create a new alert notification receiver. + input: + name: CreateAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: POST + path: /alerts/notifications/receivers + Get: + name: Get + comment: Get an existing alert notification receiver. + input: + name: GetAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: GET + path: /alerts/notifications/receivers/{ids.receiver_id} + List: + name: List + comment: List existing alert notification receivers. Returns all receivers if + no identifiers are provided. + input: + name: ListAlertNotificationReceiversRequest + output: + name: AlertNotificationReceivers + http: + - method: GET + path: /alerts/notifications/receivers + Update: + name: Update + comment: Update an existing alert notification receiver. + input: + name: UpdateAlertNotificationReceiverRequest + output: + name: AlertNotificationReceiver + http: + - method: PUT + path: /alerts/notifications/receivers/{receiver.ids.receiver_id} + Delete: + name: Delete + comment: Delete an existing alert notification receiver. + input: + name: AlertNotificationReceiverIdentifiers + output: + package: google.protobuf + name: Empty + http: + - method: DELETE + path: /alerts/notifications/receivers/{receiver_id} diff --git a/doc/data/api/tti.lorawan.v3/services/Ars.yml b/doc/data/api/tti.lorawan.v3/services/Ars.yml new file mode 100644 index 0000000000..18395a2153 --- /dev/null +++ b/doc/data/api/tti.lorawan.v3/services/Ars.yml @@ -0,0 +1,11 @@ +name: Ars +methods: + GetConfiguration: + name: GetConfiguration + input: + name: GetArsConfigurationRequest + output: + name: GetArsConfigurationResponse + http: + - method: GET + path: /ars/configuration diff --git a/doc/data/api/ttn.lorawan.v3/enums/ClusterRole.yml b/doc/data/api/ttn.lorawan.v3/enums/ClusterRole.yml index b79d169f8d..3e66bf0673 100644 --- a/doc/data/api/ttn.lorawan.v3/enums/ClusterRole.yml +++ b/doc/data/api/ttn.lorawan.v3/enums/ClusterRole.yml @@ -34,3 +34,5 @@ values: value: 102 - name: NETWORK_OPERATIONS_CENTER value: 103 +- name: ALERT_ROUTING_SERVER + value: 104 diff --git a/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml b/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml new file mode 100644 index 0000000000..681617a1c5 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/AlertNotificationProfileIdentifiers.yml @@ -0,0 +1,8 @@ +name: AlertNotificationProfileIdentifiers +fields: +- name: profile_id + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateRelayRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayRequest.yml new file mode 100644 index 0000000000..4e7035b257 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayRequest.yml @@ -0,0 +1,16 @@ +name: CreateRelayRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: settings + comment: Relay configuration. + message: + name: RelaySettings + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateRelayResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayResponse.yml new file mode 100644 index 0000000000..cedd6c05f5 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayResponse.yml @@ -0,0 +1,7 @@ +name: CreateRelayResponse +fields: +- name: settings + comment: Relay configuration. + message: + name: RelaySettings + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleRequest.yml new file mode 100644 index 0000000000..4d0cd4cc63 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleRequest.yml @@ -0,0 +1,22 @@ +name: CreateRelayUplinkForwardingRuleRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: index + comment: Index of the uplink forwarding rule. + type: uint32 + rules: + lte: 15 + default: 0 +- name: rule + comment: Uplink forwarding rule. + message: + name: RelayUplinkForwardingRule + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleResponse.yml new file mode 100644 index 0000000000..dcd6bc519e --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/CreateRelayUplinkForwardingRuleResponse.yml @@ -0,0 +1,7 @@ +name: CreateRelayUplinkForwardingRuleResponse +fields: +- name: rule + comment: Uplink forwarding rule. + message: + name: RelayUplinkForwardingRule + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayRequest.yml new file mode 100644 index 0000000000..cb49bbaced --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayRequest.yml @@ -0,0 +1,9 @@ +name: DeleteRelayRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayResponse.yml new file mode 100644 index 0000000000..a26430d3c5 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayResponse.yml @@ -0,0 +1 @@ +name: DeleteRelayResponse diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleRequest.yml new file mode 100644 index 0000000000..f7b9397c34 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleRequest.yml @@ -0,0 +1,15 @@ +name: DeleteRelayUplinkForwardingRuleRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: index + comment: Index of the uplink forwarding rule. + type: uint32 + rules: + lte: 15 + default: 0 diff --git a/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleResponse.yml new file mode 100644 index 0000000000..6e1ff8d898 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/DeleteRelayUplinkForwardingRuleResponse.yml @@ -0,0 +1 @@ +name: DeleteRelayUplinkForwardingRuleResponse diff --git a/doc/data/api/ttn.lorawan.v3/messages/EmailValidation.yml b/doc/data/api/ttn.lorawan.v3/messages/EmailValidation.yml new file mode 100644 index 0000000000..51943b37e8 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/EmailValidation.yml @@ -0,0 +1,34 @@ +name: EmailValidation +fields: +- name: id + type: string + rules: + min_len: 1 + max_len: 64 + default: "" +- name: token + type: string + rules: + min_len: 1 + max_len: 64 + default: "" +- name: address + type: string + rules: + email: true + default: "" +- name: created_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: expires_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" +- name: updated_at + message: + package: google.protobuf + name: Timestamp + default: "0001-01-01T00:00:00Z" diff --git a/doc/data/api/ttn.lorawan.v3/messages/Gateway.yml b/doc/data/api/ttn.lorawan.v3/messages/Gateway.yml index 0b4716268a..b14f646991 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/Gateway.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/Gateway.yml @@ -219,3 +219,8 @@ fields: - name: disable_packet_broker_forwarding type: bool default: false +- name: alert_notification_profile_ids + comment: 'next: 33' + message: + name: AlertNotificationProfileIdentifiers + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetRelayRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/GetRelayRequest.yml new file mode 100644 index 0000000000..f4435a03ee --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetRelayRequest.yml @@ -0,0 +1,15 @@ +name: GetRelayRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: field_mask + comment: Field mask of the fields to return. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetRelayResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/GetRelayResponse.yml new file mode 100644 index 0000000000..f8f2dc02c9 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetRelayResponse.yml @@ -0,0 +1,7 @@ +name: GetRelayResponse +fields: +- name: settings + comment: Relay configuration. + message: + name: RelaySettings + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleRequest.yml new file mode 100644 index 0000000000..c3142a4517 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleRequest.yml @@ -0,0 +1,21 @@ +name: GetRelayUplinkForwardingRuleRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: index + comment: Index of the uplink forwarding rule. + type: uint32 + rules: + lte: 15 + default: 0 +- name: field_mask + comment: Field mask of the fields to return. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleResponse.yml new file mode 100644 index 0000000000..3db084ccf7 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/GetRelayUplinkForwardingRuleResponse.yml @@ -0,0 +1,7 @@ +name: GetRelayUplinkForwardingRuleResponse +fields: +- name: rule + comment: Uplink forwarding rule. + message: + name: RelayUplinkForwardingRule + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesRequest.yml new file mode 100644 index 0000000000..504a6cf60d --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesRequest.yml @@ -0,0 +1,15 @@ +name: ListRelayUplinkForwardingRulesRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: field_mask + comment: Field mask of the fields to return. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesResponse.yml new file mode 100644 index 0000000000..1b61004fbb --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ListRelayUplinkForwardingRulesResponse.yml @@ -0,0 +1,8 @@ +name: ListRelayUplinkForwardingRulesResponse +fields: +- name: rules + comment: Uplink forwarding rules. + repeated: + message: + name: RelayUplinkForwardingRule + default: [] diff --git a/doc/data/api/ttn.lorawan.v3/messages/MACSettings.yml b/doc/data/api/ttn.lorawan.v3/messages/MACSettings.yml index f4e8d86c79..8175d685b0 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/MACSettings.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/MACSettings.yml @@ -247,15 +247,15 @@ fields: default: {} - name: relay comment: |- - The relay parameters the end device is using. + The relay settings the end device is using. If unset, the default value from Network Server configuration or regional parameters specification will be used. message: - name: RelayParameters + name: RelaySettings default: {} - name: desired_relay comment: |- - The relay parameters the Network Server should configure device to use via MAC commands. + The relay settings the Network Server should configure device to use via MAC commands. If unset, the default value from Network Server configuration or regional parameters specification will be used. message: - name: RelayParameters + name: RelaySettings default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/Organization.yml b/doc/data/api/ttn.lorawan.v3/messages/Organization.yml index f6d4958164..4e9c8556e2 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/Organization.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/Organization.yml @@ -99,3 +99,9 @@ fields: package: google.protobuf name: UInt64Value default: null +- name: fanout_notifications + comment: |- + Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the + administrative or technical contact. + type: bool + default: false diff --git a/doc/data/api/ttn.lorawan.v3/messages/RelaySettings.yml b/doc/data/api/ttn.lorawan.v3/messages/RelaySettings.yml new file mode 100644 index 0000000000..8f5faf473f --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/RelaySettings.yml @@ -0,0 +1,18 @@ +name: RelaySettings +comment: |- + RelaySettings represent the settings of a relay. + This is used internally by the Network Server. +fields: +- name: serving + message: + name: ServingRelaySettings + default: {} +- name: served + message: + name: ServedRelaySettings + default: {} +oneofs: +- name: mode + field_names: + - serving + - served diff --git a/doc/data/api/ttn.lorawan.v3/messages/ServedRelayParameters.yml b/doc/data/api/ttn.lorawan.v3/messages/ServedRelayParameters.yml index 5881e20a99..eb47e81204 100644 --- a/doc/data/api/ttn.lorawan.v3/messages/ServedRelayParameters.yml +++ b/doc/data/api/ttn.lorawan.v3/messages/ServedRelayParameters.yml @@ -20,7 +20,8 @@ fields: name: RelayEndDeviceControlledMode default: {} - name: backoff - comment: Number of uplinks to be sent without a wake on radio frame. + comment: Number of wake on radio frames to be sent without an acknowledgement before + sending the uplink message directly. type: uint32 rules: lte: 63 diff --git a/doc/data/api/ttn.lorawan.v3/messages/ServedRelaySettings.yml b/doc/data/api/ttn.lorawan.v3/messages/ServedRelaySettings.yml new file mode 100644 index 0000000000..57749a5055 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ServedRelaySettings.yml @@ -0,0 +1,49 @@ +name: ServedRelaySettings +fields: +- name: always + comment: The end device will always attempt to use the relay mode in order to send + uplink messages. + message: + name: RelayEndDeviceAlwaysMode + default: {} +- name: dynamic + comment: |- + The end device will attempt to use relay mode only after a number of uplink messages have been sent without + receiving a valid a downlink message. + message: + name: RelayEndDeviceDynamicMode + default: {} +- name: end_device_controlled + comment: The end device will control when it uses the relay mode. This is the default + mode. + message: + name: RelayEndDeviceControlledMode + default: {} +- name: backoff + comment: |- + Number of wake on radio frames to be sent without an acknowledgement before sending the uplink message directly. + If unset, the default value from Network Server configuration will be used. + message: + package: google.protobuf + name: UInt32Value + rules: + lte: 63 + default: null +- name: second_channel + comment: Second wake on radio channel configuration. + message: + name: RelaySecondChannel + default: {} +- name: serving_device_id + comment: End device identifier of the serving end device. + type: string + rules: + max_len: 36 + pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$ + default: "" +oneofs: +- name: mode + field_names: + - always + - dynamic + - end_device_controlled diff --git a/doc/data/api/ttn.lorawan.v3/messages/ServingRelaySettings.yml b/doc/data/api/ttn.lorawan.v3/messages/ServingRelaySettings.yml new file mode 100644 index 0000000000..535cbc8618 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ServingRelaySettings.yml @@ -0,0 +1,39 @@ +name: ServingRelaySettings +fields: +- name: second_channel + comment: Second wake on radio channel configuration. + message: + name: RelaySecondChannel + default: {} +- name: default_channel_index + comment: |- + Index of the default wake on radio channel. + If unset, the default value from Network Server configuration will be used. + message: + package: google.protobuf + name: UInt32Value + rules: + lte: 255 + default: null +- name: cad_periodicity + comment: Channel activity detection periodicity. + enum: + name: RelayCADPeriodicity + rules: + defined_only: true + default: RELAY_CAD_PERIODICITY_1_SECOND +- name: uplink_forwarding_rules + comment: Configured uplink forwarding rules. + rules: + max_items: 16 + repeated: + message: + name: RelayUplinkForwardingRule + default: [] +- name: limits + comment: |- + Configured forwarding limits. + If unset, the default value from Network Server configuration will be used. + message: + name: ServingRelayForwardingLimits + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayRequest.yml new file mode 100644 index 0000000000..7bbdc46b66 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayRequest.yml @@ -0,0 +1,22 @@ +name: UpdateRelayRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: settings + comment: Relay configuration. + message: + name: RelaySettings + rules: + required: true + default: {} +- name: field_mask + comment: Field mask of the fields to update. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayResponse.yml new file mode 100644 index 0000000000..08ef1efab0 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayResponse.yml @@ -0,0 +1,7 @@ +name: UpdateRelayResponse +fields: +- name: settings + comment: Relay configuration. + message: + name: RelaySettings + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleRequest.yml new file mode 100644 index 0000000000..818e416dca --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleRequest.yml @@ -0,0 +1,28 @@ +name: UpdateRelayUplinkForwardingRuleRequest +fields: +- name: end_device_ids + comment: End device identifiers of the relay. + message: + name: EndDeviceIdentifiers + rules: + required: true + default: {} +- name: index + comment: Index of the uplink forwarding rule. + type: uint32 + rules: + lte: 15 + default: 0 +- name: rule + comment: Uplink forwarding rule. + message: + name: RelayUplinkForwardingRule + rules: + required: true + default: {} +- name: field_mask + comment: Field mask of the fields to update. + message: + package: google.protobuf + name: FieldMask + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleResponse.yml new file mode 100644 index 0000000000..422ff33790 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/UpdateRelayUplinkForwardingRuleResponse.yml @@ -0,0 +1,7 @@ +name: UpdateRelayUplinkForwardingRuleResponse +fields: +- name: rule + comment: Uplink forwarding rule. + message: + name: RelayUplinkForwardingRule + default: {} diff --git a/doc/data/api/ttn.lorawan.v3/messages/ValidateEmailRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/ValidateEmailRequest.yml new file mode 100644 index 0000000000..822931b9fc --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/messages/ValidateEmailRequest.yml @@ -0,0 +1,14 @@ +name: ValidateEmailRequest +fields: +- name: id + type: string + rules: + min_len: 1 + max_len: 64 + default: "" +- name: token + type: string + rules: + min_len: 1 + max_len: 64 + default: "" diff --git a/doc/data/api/ttn.lorawan.v3/services/EmailValidationRegistry.yml b/doc/data/api/ttn.lorawan.v3/services/EmailValidationRegistry.yml new file mode 100644 index 0000000000..524112c387 --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/services/EmailValidationRegistry.yml @@ -0,0 +1,25 @@ +name: EmailValidationRegistry +comment: The EmailValidationRegistry service, exposed by the Identity Server, is used + for validating an user's primary email. +methods: + RequestValidation: + name: RequestValidation + comment: Request validation for the non-validated contact info for the given entity. + input: + name: UserIdentifiers + output: + name: EmailValidation + http: + - method: POST + path: /email/validation + Validate: + name: Validate + comment: Validate confirms a contact info validation. + input: + name: ValidateEmailRequest + output: + package: google.protobuf + name: Empty + http: + - method: PATCH + path: /email/validation diff --git a/doc/data/api/ttn.lorawan.v3/services/NsRelayConfigurationService.yml b/doc/data/api/ttn.lorawan.v3/services/NsRelayConfigurationService.yml new file mode 100644 index 0000000000..bd6f18ca6e --- /dev/null +++ b/doc/data/api/ttn.lorawan.v3/services/NsRelayConfigurationService.yml @@ -0,0 +1,94 @@ +name: NsRelayConfigurationService +comment: The NsRelayConfigurationService provides configuration management capabilities + for relays. +methods: + CreateRelay: + name: CreateRelay + comment: Create a relay. + input: + name: CreateRelayRequest + output: + name: CreateRelayResponse + http: + - method: POST + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays + GetRelay: + name: GetRelay + comment: Get a relay. + input: + name: GetRelayRequest + output: + name: GetRelayResponse + http: + - method: GET + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} + UpdateRelay: + name: UpdateRelay + comment: Update a relay. + input: + name: UpdateRelayRequest + output: + name: UpdateRelayResponse + http: + - method: PUT + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} + DeleteRelay: + name: DeleteRelay + comment: Delete a relay. + input: + name: DeleteRelayRequest + output: + name: DeleteRelayResponse + http: + - method: DELETE + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id} + CreateRelayUplinkForwardingRule: + name: CreateRelayUplinkForwardingRule + comment: Create an uplink forwarding rule. + input: + name: CreateRelayUplinkForwardingRuleRequest + output: + name: CreateRelayUplinkForwardingRuleResponse + http: + - method: POST + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules + GetRelayUplinkForwardingRule: + name: GetRelayUplinkForwardingRule + comment: Get an uplink forwarding rule. + input: + name: GetRelayUplinkForwardingRuleRequest + output: + name: GetRelayUplinkForwardingRuleResponse + http: + - method: GET + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} + ListRelayUplinkForwardingRules: + name: ListRelayUplinkForwardingRules + comment: List uplink forwarding rules. + input: + name: ListRelayUplinkForwardingRulesRequest + output: + name: ListRelayUplinkForwardingRulesResponse + http: + - method: GET + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules + UpdateRelayUplinkForwardingRule: + name: UpdateRelayUplinkForwardingRule + comment: Update an uplink forwarding rule. + input: + name: UpdateRelayUplinkForwardingRuleRequest + output: + name: UpdateRelayUplinkForwardingRuleResponse + http: + - method: PUT + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} + DeleteRelayUplinkForwardingRule: + name: DeleteRelayUplinkForwardingRule + comment: Delete an uplink forwarding rule. + input: + name: DeleteRelayUplinkForwardingRuleRequest + output: + name: DeleteRelayUplinkForwardingRuleResponse + http: + - method: DELETE + path: /ns/applications/{end_device_ids.application_ids.application_id}/relays/{end_device_ids.device_id}/uplink-forwarding-rules/{index} diff --git a/doc/data/commands/ttn-lw-cli.json b/doc/data/commands/ttn-lw-cli.json index 12ea6f53de..7bb22c4c85 100644 --- a/doc/data/commands/ttn-lw-cli.json +++ b/doc/data/commands/ttn-lw-cli.json @@ -3,6 +3,62 @@ "short": "The Things Industries Command-line Interface", "path": "ttn-lw-cli", "subCommands": { + "alert-notification-profiles": { + "short": "Alert Notification Profile commands (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles", + "subCommands": { + "create": { + "short": "Create an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles create" + }, + "delete": { + "short": "Delete an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles delete" + }, + "get": { + "short": "Get an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles get" + }, + "get-default": { + "short": "Get default alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles get-default" + }, + "list": { + "short": "List alert notification profiles (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles list" + }, + "update": { + "short": "Update an alert notification profile (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-profiles update" + } + } + }, + "alert-notification-receivers": { + "short": "Alert Notification Receiver commands (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers", + "subCommands": { + "create": { + "short": "Create an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers create" + }, + "delete": { + "short": "Delete an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers delete" + }, + "get": { + "short": "Get an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers get" + }, + "list": { + "short": "List alert notification receivers (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers list" + }, + "update": { + "short": "Update an alert notification receiver (EXPERIMENTAL)", + "path": "ttn-lw-cli alert-notification-receivers update" + } + } + }, "applications": { "short": "Application commands", "path": "ttn-lw-cli applications", @@ -73,20 +129,6 @@ } } }, - "contact-info": { - "short": "Manage application contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of application)", - "path": "ttn-lw-cli applications contact-info", - "subCommands": { - "request-validation": { - "short": "Request validation for entity contact info", - "path": "ttn-lw-cli applications contact-info request-validation" - }, - "validate": { - "short": "Validate contact info", - "path": "ttn-lw-cli applications contact-info validate" - } - } - }, "create": { "short": "Create an application", "path": "ttn-lw-cli applications create" @@ -323,20 +365,6 @@ } } }, - "contact-info": { - "short": "Manage client contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of client)", - "path": "ttn-lw-cli clients contact-info", - "subCommands": { - "request-validation": { - "short": "Request validation for entity contact info", - "path": "ttn-lw-cli clients contact-info request-validation" - }, - "validate": { - "short": "Validate contact info", - "path": "ttn-lw-cli clients contact-info validate" - } - } - }, "create": { "short": "Create a client", "path": "ttn-lw-cli clients create" @@ -621,20 +649,6 @@ } } }, - "contact-info": { - "short": "Manage gateway contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of gateway)", - "path": "ttn-lw-cli gateways contact-info", - "subCommands": { - "request-validation": { - "short": "Request validation for entity contact info", - "path": "ttn-lw-cli gateways contact-info request-validation" - }, - "validate": { - "short": "Validate contact info", - "path": "ttn-lw-cli gateways contact-info validate" - } - } - }, "create": { "short": "Create a gateway", "path": "ttn-lw-cli gateways create" @@ -765,20 +779,6 @@ } } }, - "contact-info": { - "short": "Manage organization contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of organization)", - "path": "ttn-lw-cli organizations contact-info", - "subCommands": { - "request-validation": { - "short": "Request validation for entity contact info", - "path": "ttn-lw-cli organizations contact-info request-validation" - }, - "validate": { - "short": "Validate contact info", - "path": "ttn-lw-cli organizations contact-info validate" - } - } - }, "create": { "short": "Create an organization", "path": "ttn-lw-cli organizations create" @@ -911,6 +911,54 @@ } } }, + "relays": { + "short": "Relay commands (EXPERIMENTAL)", + "path": "ttn-lw-cli relays", + "subCommands": { + "create": { + "short": "Create a relay (EXPERIMENTAL)", + "path": "ttn-lw-cli relays create" + }, + "delete": { + "short": "Delete a relay (EXPERIMENTAL)", + "path": "ttn-lw-cli relays delete" + }, + "get": { + "short": "Get a relay (EXPERIMENTAL)", + "path": "ttn-lw-cli relays get" + }, + "update": { + "short": "Update a relay (EXPERIMENTAL)", + "path": "ttn-lw-cli relays update" + }, + "uplink-forwarding-rules": { + "short": "Uplink forwarding rules commands (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules", + "subCommands": { + "create": { + "short": "Create an uplink forwarding rule (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules create" + }, + "delete": { + "short": "Delete an uplink forwarding rule (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules delete" + }, + "get": { + "short": "Get an uplink forwarding rule (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules get" + }, + "list": { + "short": "List uplink forwarding rules (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules list" + }, + "update": { + "short": "Update an uplink forwarding rule (EXPERIMENTAL)", + "path": "ttn-lw-cli relays uplink-forwarding-rules update" + } + } + } + } + }, "simulate": { "short": "Simulation commands", "path": "ttn-lw-cli simulate", @@ -1035,20 +1083,6 @@ } } }, - "contact-info": { - "short": "Manage user contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of user)", - "path": "ttn-lw-cli users contact-info", - "subCommands": { - "request-validation": { - "short": "Request validation for entity contact info", - "path": "ttn-lw-cli users contact-info request-validation" - }, - "validate": { - "short": "Validate contact info", - "path": "ttn-lw-cli users contact-info validate" - } - } - }, "create": { "short": "Create a user", "path": "ttn-lw-cli users create" @@ -1061,6 +1095,20 @@ "short": "Delete a user", "path": "ttn-lw-cli users delete" }, + "email-validations": { + "short": "Email validations commands", + "path": "ttn-lw-cli users email-validations", + "subCommands": { + "request": { + "short": "Request validation for an user's email address", + "path": "ttn-lw-cli users email-validations request" + }, + "validate": { + "short": "Validate an user's email address", + "path": "ttn-lw-cli users email-validations validate" + } + } + }, "forgot-password": { "short": "Request a temporary user password", "path": "ttn-lw-cli users forgot-password"