]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/userguide: add reload-tenant(s) doc
authorVictor Julien <vjulien@oisf.net>
Wed, 9 Aug 2023 15:35:18 +0000 (17:35 +0200)
committerVictor Julien <vjulien@oisf.net>
Fri, 11 Aug 2023 05:17:09 +0000 (07:17 +0200)
doc/userguide/configuration/multi-tenant.rst
doc/userguide/partials/commands-sc.rst

index dcd7c29affca926eecdba603136fd8206ea1fcd8..1058468a2f2f55e2bac000bb827bb0733a7c7626 100644 (file)
@@ -218,6 +218,29 @@ Tenants can be mapped to vlan ids.
 The registration of tenant and tenant handlers can be done on a
 running engine.
 
+Reloads
+~~~~~~~
+
+Reloading all tenants:
+
+``reload-tenants``
+
+::
+
+  reload-tenants
+
+Reloading a single tenant:
+
+``reload-tenant <tenant id> [yaml path]``
+
+::
+
+  reload-tenant 1 tenant-1.yaml
+  reload-tenant 5
+
+The ``[yaml path]`` is optional. If it isn't provided, the original path of
+the tenant will be used during the reload.
+
 Eve JSON output
 ---------------
 
index c99f67d8e7b8fc17b3ff6157b8ebe98995662cba..d34707f35ab3b93c33f94a797b04ac1b99d8e935 100644 (file)
    specified. If it is omitted, the original yaml that was used to load
    / last reload the tenant is used.
 
+.. describe:: reload-tenants
+
+   Reload all registered tenants by reloading their yaml.
+
 .. describe:: unregister-tenant <id>
 
    Unregister tenant with a particular ID.