summaryrefslogtreecommitdiff
path: root/docs/cli.rst
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2021-11-30 19:42:13 +0100
committerGitHub <noreply@github.com>2021-11-30 19:42:13 +0100
commit6d3288942966458320d4e8a9e8dc565cea40181c (patch)
treefcd2a33a2d6b2fe5488602aa9a58f092d8ab5fec /docs/cli.rst
parentd9133703c58f229049358ad8df0618bc9134b14f (diff)
parent4ebd7287b0eed3eaada4c1120c06f7c790948a20 (diff)
downloadvyos-documentation-6d3288942966458320d4e8a9e8dc565cea40181c.tar.gz
vyos-documentation-6d3288942966458320d4e8a9e8dc565cea40181c.zip
Merge pull request #668 from sever-sever/doc-json-current
op-mode: Add doc for show configuration JSON 1.4
Diffstat (limited to 'docs/cli.rst')
-rw-r--r--docs/cli.rst105
1 files changed, 105 insertions, 0 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 884c3d51..df50782f 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -228,6 +228,111 @@ special way on how to :ref:`run_opmode_from_config_mode`.
.. _`forum`: https://forum.vyos.io
+.. opcmd:: show configuration json
+
+ View the current active configuration in JSON format.
+
+ .. code-block:: none
+
+ {"interfaces": {"ethernet": {"eth0": {"address": ["192.0.2.11/24", "192.0.2.35/24"], "hw-id": "52:54:00:48:a0:c6"}, "eth1": {"address": ["203.0.113.1/24"], "hw-id": "52:54:00:fc:50:0b"}}, "loopback": {"lo": {}}}, "protocols": {"static": {"route": {"0.0.0.0/0": {"next-hop": {"192.0.2.254": {}}}}}}, "service": {"ssh": {"disable-host-validation": {}}}, "system": {"config-management": {"commit-revisions": "100"}, "console": {"device": {"ttyS0": {"speed": "115200"}}}, "host-name": "r11-vyos", "login": {"user": {"vyos": {"authentication": {"encrypted-password": "$6$Vt68...F0", "plaintext-password": "", "public-keys": {"vyos@vyos": {"key": "AAAAxxx=", "type": "ssh-rsa"}}}}}}, "name-server": ["203.0.113.254"], "ntp": {"server": {"time1.vyos.net": {}, "time2.vyos.net": {}, "time3.vyos.net": {}}}, "syslog": {"global": {"facility": {"all": {"level": "info"}, "protocols": {"level": "debug"}}}}, "time-zone": "America/New_York"}}
+
+.. opcmd:: show configuration json pretty
+
+ View the current active configuration in readable JSON format.
+
+ .. code-block:: none
+
+ {
+ "interfaces": {
+ "ethernet": {
+ "eth0": {
+ "address": [
+ "192.0.2.11/24",
+ "192.0.2.35/24"
+ ],
+ "hw-id": "52:54:00:48:a0:c6"
+ },
+ "eth1": {
+ "address": [
+ "203.0.113.1/24"
+ ],
+ "hw-id": "52:54:00:fc:50:0b"
+ }
+ },
+ "loopback": {
+ "lo": {}
+ }
+ },
+ "protocols": {
+ "static": {
+ "route": {
+ "0.0.0.0/0": {
+ "next-hop": {
+ "192.0.2.254": {}
+ }
+ }
+ }
+ }
+ },
+ "service": {
+ "ssh": {
+ "disable-host-validation": {}
+ }
+ },
+ "system": {
+ "config-management": {
+ "commit-revisions": "100"
+ },
+ "console": {
+ "device": {
+ "ttyS0": {
+ "speed": "115200"
+ }
+ }
+ },
+ "host-name": "r11-vyos",
+ "login": {
+ "user": {
+ "vyos": {
+ "authentication": {
+ "encrypted-password": "$6$Vt68...F0",
+ "plaintext-password": "",
+ "public-keys": {
+ "vyos@vyos": {
+ "key": "AAAAxxx=",
+ "type": "ssh-rsa"
+ }
+ }
+ }
+ }
+ }
+ },
+ "name-server": [
+ "203.0.113.254"
+ ],
+ "ntp": {
+ "server": {
+ "time1.vyos.net": {},
+ "time2.vyos.net": {},
+ "time3.vyos.net": {}
+ }
+ },
+ "syslog": {
+ "global": {
+ "facility": {
+ "all": {
+ "level": "info"
+ },
+ "protocols": {
+ "level": "debug"
+ }
+ }
+ }
+ },
+ "time-zone": "America/New_York"
+ }
+ }
+
The config mode
---------------