From c0201d32127c59be61508e8bd3fdd6ccb2c4a1e8 Mon Sep 17 00:00:00 2001 From: Victor Julien Date: Wed, 9 Aug 2023 17:35:18 +0200 Subject: [PATCH] doc/userguide: add reload-tenant(s) doc --- doc/userguide/configuration/multi-tenant.rst | 23 ++++++++++++++++++++ doc/userguide/partials/commands-sc.rst | 4 ++++ 2 files changed, 27 insertions(+) diff --git a/doc/userguide/configuration/multi-tenant.rst b/doc/userguide/configuration/multi-tenant.rst index dcd7c29aff..1058468a2f 100644 --- a/doc/userguide/configuration/multi-tenant.rst +++ b/doc/userguide/configuration/multi-tenant.rst @@ -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 [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 --------------- diff --git a/doc/userguide/partials/commands-sc.rst b/doc/userguide/partials/commands-sc.rst index c99f67d8e7..d34707f35a 100644 --- a/doc/userguide/partials/commands-sc.rst +++ b/doc/userguide/partials/commands-sc.rst @@ -88,6 +88,10 @@ 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 Unregister tenant with a particular ID. -- 2.47.2