From: Tomek Mrugalski <tomasz@isc.org>
Date: Mon, 19 Aug 2019 15:00:35 +0000 (+0200)
Subject: Fixed server-tag-get docs
X-Git-Tag: Kea-1.6.0~34
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cf18a81f46ab23dedea8afd1c9f4eb277234df04;p=thirdparty%2Fkea.git

Fixed server-tag-get docs
---

diff --git a/doc/sphinx/api/server-tag-get.json b/doc/sphinx/api/server-tag-get.json
index 54d74a1e80..c1efc5dd68 100644
--- a/doc/sphinx/api/server-tag-get.json
+++ b/doc/sphinx/api/server-tag-get.json
@@ -1,7 +1,10 @@
 {
     "avail": "1.6.0",
     "brief": [
-        "This command returns the server tag."
+        "This command returns the server tag used by the server. ",
+        "Server tag is essential configuration parameter in the Config Backend configuration.",
+        "This parameter is configured in the local config file.",
+        "This command does not take any parameters."
     ],
     "cmd-syntax": [
         "{",
@@ -10,6 +13,15 @@
     ],
     "description": "See <xref linkend=\"command-server-tag-get\"/>",
     "name": "server-tag-get",
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"arguments\": {",
+        "        \"server-tag\": \"office1\"",
+        "    }",
+        "}"
+    ],
+
     "support": [
         "kea-dhcp4",
         "kea-dhcp6"
diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst
index 0edbb1fc55..b03a4d201c 100644
--- a/doc/sphinx/arm/config-backend.rst
+++ b/doc/sphinx/arm/config-backend.rst
@@ -141,6 +141,8 @@ the list of supported configuration parameters, can be found in
 
 .. _cb-sharing:
 
+.. _command-server-tag-get:
+
 Configuration Sharing and Server Tags
 -------------------------------------
 
@@ -156,7 +158,8 @@ by "server tags". The server tag is an arbitrary string holding the name
 of the Kea server instance. The tags of the DHCPv4 and DHCPv6 servers are
 independent in the database, i.e. the same server tag can be created for
 the DHCPv4 and the DHCPv6 server respectively. The value is configured
-using ``server-tag`` parameter in the Dhcp4 or Dhcp6 scope.
+using ``server-tag`` parameter in the Dhcp4 or Dhcp6 scope. The current
+server-tag can be checked with the ``server-tag-get`` command.
 
 The server definition, which consists of the server tag and the server
 description, must be stored in the configuration database prior to creating