summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
m---------docs/_include/vyos-1x0
-rw-r--r--docs/_templates/layout.html3
-rw-r--r--docs/automation/index.rst4
-rw-r--r--docs/automation/vyos-api.rst317
-rw-r--r--docs/changelog/1.3.rst139
-rw-r--r--docs/configuration/interfaces/pppoe.rst6
-rw-r--r--docs/configuration/service/https.rst186
-rw-r--r--docs/configuration/service/ipoe-server.rst4
8 files changed, 511 insertions, 148 deletions
diff --git a/docs/_include/vyos-1x b/docs/_include/vyos-1x
-Subproject 350180a60b9d80b189db51d8e643c9798192a81
+Subproject 35e596811820dea92ed20759a2e8f4bd84a88c8
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
index 387301ea..5501e663 100644
--- a/docs/_templates/layout.html
+++ b/docs/_templates/layout.html
@@ -1,4 +1,5 @@
{% extends "!layout.html" %}
+{%- set current_version = "1.3.x equuleus" %}
{% block extrahead %}
<link href="{{ pathto("_static/css/custom.css", True) }}" rel="stylesheet" type="text/css">
-{% endblock %} \ No newline at end of file
+{% endblock %}
diff --git a/docs/automation/index.rst b/docs/automation/index.rst
index e07dfecc..c19d819b 100644
--- a/docs/automation/index.rst
+++ b/docs/automation/index.rst
@@ -5,11 +5,11 @@ VyOS Automation
* Ansible
* Saltstack
- * HTTP-API
* startup scripts
.. toctree::
:maxdepth: 1
-
+
+ vyos-api
command-scripting \ No newline at end of file
diff --git a/docs/automation/vyos-api.rst b/docs/automation/vyos-api.rst
new file mode 100644
index 00000000..1504a05a
--- /dev/null
+++ b/docs/automation/vyos-api.rst
@@ -0,0 +1,317 @@
+.. _vyosapi:
+
+########
+VyOS API
+########
+
+for configuration and enabling the API see :ref:`http-api`
+
+**************
+Authentication
+**************
+
+All Endpoint only listen on HTTP POST requests and the API KEY must set as
+``key`` in the formdata.
+
+Below see one example or curl and one for python.
+In the following, the documentation is reduced to curl.
+
+.. code-block:: none
+
+ curl --location --request POST 'https://vyos/retrieve' \
+ --form data='{"op": "showConfig", "path": []}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+.. code-block:: python
+
+ import requests
+ url = "https://vyos/retrieve"
+ payload={'data': '{"op": "showConfig", "path": []}',
+ 'key': 'MY-HTTPS-API-PLAINTEXT-KEY'
+ }
+ headers = {}
+ response = requests.request("POST", url, headers=headers, data=payload)
+ print(response.text)
+
+
+*************
+API Endpoints
+*************
+
+/retrieve
+=========
+
+With the ``retrieve`` endpoint you get parts or the whole configuration.
+
+To get the whole configuration, pass an empty list to the ``path`` field
+
+.. code-block:: none
+
+ curl --location --request POST 'https://vyos/retrieve' \
+ --form data='{"op": "showConfig", "path": []}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+
+ response (shorted)
+ {
+ "success": true,
+ "data": {
+ "interfaces": {
+ "ethernet": {
+ "eth0": {
+ "address": "dhcp",
+ "duplex": "auto",
+ "hw-id": "50:00:00:01:00:00",
+ "speed": "auto"
+ },
+ "eth1": {
+ "duplex": "auto",
+ "hw-id": "50:00:00:01:00:01",
+ "speed": "auto"
+ ...
+ },
+ "error": null
+ }
+
+
+only get a part of the configuration,
+for example ``system syslog``.
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/retrieve' \
+ --form data='{"op": "showConfig", "path": ["system", "syslog"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+
+ response:
+ {
+ "success": true,
+ "data": {
+ "global": {
+ "facility": {
+ "all": {
+ "level": "info"
+ },
+ "protocols": {
+ "level": "debug"
+ }
+ }
+ }
+ },
+ "error": null
+ }
+
+if you just want the Value of a multi-valued node, use the ``returnValues``
+operation.
+
+for example get the addresses of a ``dum0`` interface
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/retrieve' \
+ --form data='{"op": "returnValues", "path": ["interfaces","dummy","dum0","address"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ respone:
+ {
+ "success": true,
+ "data": [
+ "10.10.10.10/24",
+ "10.10.10.11/24",
+ "10.10.10.12/24"
+ ],
+ "error": null
+ }
+
+/image
+======
+
+To add or delete an image, use the ``/image`` endpoint.
+
+add an image
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/image' \
+ --form data='{"op": "add", "url": "https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso"}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ respone (shorted):
+ {
+ "success": true,
+ "data": "Trying to fetch ISO file from https://downloads.vyos.io/rolling-latest.iso\n
+ ...
+ Setting up grub configuration...\nDone.\n",
+ "error": null
+ }
+
+delete an image, for example ``1.3-rolling-202006070117``
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/image' \
+ --form data='{"op": "delete", "name": "1.3-rolling-202006070117"}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": "Deleting the \"1.3-rolling-202006070117\" image...\nDone\n",
+ "error": null
+ }
+
+
+/show
+=====
+
+The ``/show`` endpoint is to show everthing in operational mode
+
+for example which images are installed
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/show' \
+ --form data='{"op": "show", "path": ["system", "image"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": "The system currently has the following image(s) installed:\n\n
+ 1: 1.4-rolling-202102280559 (default boot)\n
+ 2: 1.4-rolling-202102230218\n
+ 3: 1.3-beta-202102210443\n\n",
+ "error": null
+ }
+
+
+/generate
+=========
+
+to run a ``generate`` command use the
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/generate' \
+ --form data='{"op": "generate", "path": ["wireguard", "default-keypair"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": "",
+ "error": null
+ }
+
+
+/configure
+==========
+
+You can pass a ``set``, ``delete`` or ``comment`` command to the
+``/configure`` endpoint.
+
+``set`` a single command
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/configure' \
+ --form data='{"op": "set", "path": ["interfaces", "dummy", "dum1", "address", "10.11.0.1/32"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": null,
+ "error": null
+ }
+
+
+``delete`` a single command
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/configure' \
+ --form data='{"op": "delete", "path": ["interfaces", "dummy", "dum1", "address", "10.11.0.1/32"]}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": null,
+ "error": null
+ }
+
+The API push every request to a session and commit it.
+But some of VyOS components like DHCP and PPPoE Servers, IPSec, VXLAN, and
+other tunnels require full configuration for commit.
+The Endpoint will process multiple commands when you pass them as a list to
+the ``data`` field.
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/configure' \
+ --form data='[{"op": "set","path":["interfaces","vxlan","vxlan1","remote","203.0.113.99"]}, {"op": "set","path":["interfaces","vxlan","vxlan1","vni","1"]}]' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": null,
+ "error": null
+ }
+
+
+/config-file
+============
+
+The endpoint ``/config-file`` is to save or load a configuration.
+
+Save a running configuration to the startup configuration.
+When you don't specify the file when saving, it saves to
+``/config/config.boot``.
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/config-file' \
+ --form data='{"op": "save"}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": "Saving configuration to '/config/config.boot'...\nDone\n",
+ "error": null
+ }
+
+
+Save a running configuration to a file.
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/config-file' \
+ --form data='{"op": "save", "file": "/config/test.config"}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": "Saving configuration to '/config/test.config'...\nDone\n",
+ "error": null
+ }
+
+
+To Load a configuration file.
+
+.. code-block:: none
+
+ curl -k --location --request POST 'https://vyos/config-file' \
+ --form data='{"op": "load", "file": "/config/test.config"}' \
+ --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+ response:
+ {
+ "success": true,
+ "data": null,
+ "error": null
+ } \ No newline at end of file
diff --git a/docs/changelog/1.3.rst b/docs/changelog/1.3.rst
index c819323f..dc00129b 100644
--- a/docs/changelog/1.3.rst
+++ b/docs/changelog/1.3.rst
@@ -8,6 +8,142 @@
_ext/releasenotes.py
+2021-04-04
+==========
+
+* :vytask:`T3457` (feature): Output the "monitor log" command in a colorful way
+
+
+2021-03-31
+==========
+
+* :vytask:`T3445` (bug): vyos-1x build include not all nodes
+
+
+2021-03-29
+==========
+
+* :vytask:`T3446` (default): Cloudinit error message when empty domain is passed to filter.
+* :vytask:`T3432` (default): Azure ssh keys not working for version 1.2.7/1.3.x
+
+
+2021-03-25
+==========
+
+* :vytask:`T2639` (feature): sort output of show vpn ipsec sa
+
+
+2021-03-24
+==========
+
+* :vytask:`T3359` (default): static route table not working properly
+* :vytask:`T3307` (default): address prefix destination NAT fails to render nftables rules / commit
+
+
+2021-03-22
+==========
+
+* :vytask:`T3284` (bug): merge/load fail silently if unable to resolve host
+
+
+2021-03-21
+==========
+
+* :vytask:`T3416` (bug): NTP: when running inside a VRF op-mode commands do not work
+
+
+2021-03-20
+==========
+
+* :vytask:`T3392` (bug): vrrp over dhcp default route bug (unexpected vrf)
+* :vytask:`T3373` (feature): Upgrade to SaltStack version 3002.5
+* :vytask:`T3329` (default): "system conntrack ignore" rules can no longer be created due to an iptables syntax change
+* :vytask:`T3300` (feature): Add DHCP default route distance
+* :vytask:`T3306` (feature): Extend set route-map aggregator as to 4 Bytes
+
+
+2021-03-18
+==========
+
+* :vytask:`T3411` (default): Extend the redirect_stdout context manager in vyos-configd to redirect stdout from subprocesses
+* :vytask:`T3271` (bug): qemu-kvm grub issue
+
+
+2021-03-17
+==========
+
+* :vytask:`T3413` (bug): Configuring invalid IPv6 EUI64 address results in "OSError: illegal IP address string passed to inet_pton"
+
+
+2021-03-14
+==========
+
+* :vytask:`T2271` (feature): OSPF: add per VRF instance support
+* :vytask:`T175` (feature): Add source route option to vti interface
+
+
+2021-03-13
+==========
+
+* :vytask:`T3406` (bug): tunnel: interface no longer supports specifying encaplimit none - or migrator is missing
+* :vytask:`T3407` (bug): console-server: do not allow to spawn a console-server session on serial port used by "system console"
+
+
+2021-03-11
+==========
+
+* :vytask:`T3399` (bug): RPKI: dashes in hostnames are replaced with underscores when rendering the FRR config
+* :vytask:`T3305` (bug): Ingress qdisc does not work anymore in 1.3-rolling-202101 snapshot
+* :vytask:`T2927` (bug): isc-dhcpd release and expiry events never execute
+* :vytask:`T899` (bug): Tunnels cannot be moved from one bridge to another
+* :vytask:`T786` (feature): new style xml and conf-mode scripts: posibillity to add tagNode value as parameter to conf-script
+
+
+2021-03-09
+==========
+
+* :vytask:`T3389` (default): gretap tunnel type missing from vyos documentation after renamed from gre-bridge
+* :vytask:`T3382` (bug): Error creating Console Server
+
+
+2021-03-08
+==========
+
+* :vytask:`T3387` (bug): Command "Monitor vpn ipsec" is not working
+
+
+2021-03-07
+==========
+
+* :vytask:`T3319` (bug): VXLAN uses ttl 1 (auto) by default
+* :vytask:`T3391` (feature): Add CLI support for specifying maximum-paths per address family ipv4 unicast and ipv6 unicast
+* :vytask:`T3211` (feature): ability to redistribute ISIS into other routing protocols
+
+
+2021-03-05
+==========
+
+* :vytask:`T2659` (feature): Add fastnetmon (DDoS detection) support
+
+
+2021-03-04
+==========
+
+* :vytask:`T2861` (bug): route-map "set community additive" not working correctly
+
+
+2021-03-03
+==========
+
+* :vytask:`T2966` (feature): tunnel: add new encapsulation types ip6tnl and ip6gretap
+
+
+2021-03-01
+==========
+
+* :vytask:`T3342` (bug): On xen-netback interfaces must set "scattergather" offload before MTU>1500
+
+
2021-02-28
==========
@@ -20,7 +156,6 @@
* :vytask:`T2291` (bug): Bad hostnames in /etc/hosts with static-mapping in dhcp server config
* :vytask:`T3364` (feature): tunnel: cleanup/rename CLI nodes
-* :vytask:`T3211` (feature): ability to redistribute ISIS into other routing protocols
* :vytask:`T3368` (feature): macsec: add support for gcm-aes-256 cipher
* :vytask:`T3366` (bug): tunnel: can not change local / remote ip address for gre-bridge tunnel
@@ -75,7 +210,7 @@
2021-02-16
==========
-* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.101 / 5.10.19
+* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.109 / 5.10.27
2021-02-14
diff --git a/docs/configuration/interfaces/pppoe.rst b/docs/configuration/interfaces/pppoe.rst
index 0fdbba42..fc58a1e6 100644
--- a/docs/configuration/interfaces/pppoe.rst
+++ b/docs/configuration/interfaces/pppoe.rst
@@ -310,8 +310,8 @@ If you do not know the prefix size delegated to you, start with sla-len 0.
set interfaces pppoe pppoe0 authentication user vyos
set interfaces pppoe pppoe0 authentication password vyos
- set interfaces pppoe pppoe0 dhcpv6-options prefix-delegation interface eth0 address 65535
- set interfaces pppoe pppoe0 dhcpv6-options prefix-delegation interface eth0 sla-id 0
- set interfaces pppoe pppoe0 dhcpv6-options prefix-delegation interface eth0 sla-len 8
+ set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth0 address '1'
+ set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth0 sla-id '0'
+ set interfaces pppoe pppoe0 dhcpv6-options pd 0 length '56'
set interfaces pppoe pppoe0 ipv6 address autoconf
set interfaces pppoe pppoe0 source-interface eth1
diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst
index b9c691da..1f1e2aa9 100644
--- a/docs/configuration/service/https.rst
+++ b/docs/configuration/service/https.rst
@@ -4,178 +4,88 @@
HTTP-API
########
-Enabling HTTP-API
------------------
+VyOS provide a HTTP API. You can use it to execute op-mode commands,
+update VyOS, set or delete config.
-VyOS HTTP API can be enabled through the ``set service https api`` command.
-
-.. code-block:: none
-
- set service https api debug
- set service https api keys id MY-HTTP-API-ID key MY-HTTP-API-PLAINTEXT-KEY
-
-The local API process listens on localhost:8080, and nginx exposes it on all
-virtual servers, by default. For the purpose of illustration below, we will
-assume nginx is running at https://192.168.122.127.
-
-One can limit proxying to specific listen addresses/ports/server-names by
-defining a ``service https virtual-host <id>``, and setting ``service https
-api-restrict virtual-host <id>``.
-
-.. code-block:: none
-
- set service https virtual-host example listen-address 192.168.122.127
- set service https virtual-host example listen-port 44302
- set service https virtual-host example server-name example.net
-
- set service https api-restrict virtual-host example
-
-In this example, nginx will proxy only those requests to
-192.168.122.127:44302 or example.net:44302 (assuming the DNS record is
-viable). Omitting any of listen-address, listen-port, or server-name, will
-leave appropriate defaults in the nginx directive. Multiple instances of
-``service https api-restrict virtual-host`` may be set.
-
-Configuration mode requests
----------------------------
-
-In our example, we are creating a dummy interface and assigning an address to
-it:
-
-.. code-block:: none
-
- curl -k -X POST -F data='{"op": "set", "path": ["interfaces", "dummy", "dum1", "address"], "value": "203.0.113.76/32"}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/configure
-
-The ``/configure`` endpoint takes a request serialized in JSON. The only HTTP
-method it uses is POST. Request data is passed in the ``data=`` field and the
-API key is passed in the ``key=`` field. Key identifiers from the config are
-purely informational and the application doesn't need to know them, they only
-appear in the server logs to avoid exposing keys in log files, you only need
-the key itself.
-
-Since internally there is no distinction between a path and a value, you can
-omit the value field and include the value in the path like it's done in the
-shell commands:
-
-.. code-block:: none
-
- curl -k -X POST -F data='{"op": "set", "path": ["interfaces", "dummy", "dum10", "address", "203.0.113.99/32"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/configure
-
-Separate value field make the semantics more clear though, and also makes it
-easier to create a command template once and update it with different values
-as needed.
-
-You can pass the ``set``, ``delete`` or ``comment`` command to it.
-The API will push the command to the session and commit.
-
-To retrieve a value:
-
-.. code-block:: none
-
- curl -k -X POST -F data='{"op": "returnValue", "path": ["interfaces", "dummy", "dum1", "address"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/retrieve
-
-Use ``returnValues`` for multi-valued nodes.
+Please take a look at the :ref:`vyosapi` page for an detailed how-to.
+*************
+Configuration
+*************
-Show config
-"""""""""""
+.. cfgcmd:: set service https api keys id <name> key <apikey>
-To retrieve the full config under a path:
+ Set an named api key, every key have the same, full permissions
+ on the system.
-.. code-block:: none
-
- # curl -k -X POST -F data='{"op": "showConfig", "path": ["interfaces", "dummy"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/retrieve
+.. cfgcmd:: set service https api debug
-It will return:
-
-.. code-block:: none
+ To enable debug messages. Available via :opcmd:`show log` or
+ :opcmd:`monitor log`
- {"success": true, "data": {"dummy": {"dum1": {"address": "203.0.113.76/32"}}}, "error": null}
-
-Passing an empty path will return the full config:
-
-.. code-block:: none
+.. cfgcmd:: set service https api port
- # curl -k -X POST -F data='{"op": "showConfig", "path": []}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/retrieve
+ Set the listen port of the local API, this have non effect of the
+ webserver. The default is port 8080
+.. cfgcmd:: set service https api strict
-Configuration management requests
----------------------------------
+ Enforce strict path checking
-When saving or loading a configuration, the endpoint is ``/config-file`` and
-you can pass the ``save`` or ``load`` command.
+.. cfgcmd:: set service https virtual-host <vhost> listen-address
-If you don't specify the file when saving, it saves to ``/config/config.boot``.
-Here's an example:
+ Address to listen for HTTPS requests
-.. code-block:: none
+.. cfgcmd:: set service https virtual-host <vhost> listen-port <1-65535>
- # curl -k -X POST -F key=MY-HTTP-API-PLAINTEXT-KEY -Fdata='{"op": "save", "file": "/config/config.boot"}' https://192.168.122.127/config-file
+ Port to listen for HTTPS requests; default 443
-Image management requests
--------------------------
+.. cfgcmd:: set service https virtual-host <vhost> server-name <text>
-One may ``add`` or ``delete`` a system image using the endpoint ``/image``.
-Here are the respective examples:
+ Server names for virtual hosts it ca be exact, wildcard or regex.
-``add`` from ``url``. Here we use the URL of the latest rolling release:
+.. cfgcmd:: set service https api-restrict virtual-host <vhost>
-.. code-block:: none
+ Nginx exposes the local API on all virtual servers, by default
+ Use this to restrict nginx to one or more virtual hosts.
- # curl -k -X POST -F data='{"op": "add", "url": "https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso"}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/image
+.. cfgcmd:: set service https certificates certbot domain-name <text>
-``delete`` by image ``name``. For example:
+ Domain name(s) for which to obtain certificate
-.. code-block:: none
+.. cfgcmd:: set service https certificates certbot email
- # curl -k -X POST -F data='{"op": "delete", "name": "1.3-rolling-202006070117"}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/image
+ Email address to associate with certificate
-To list the available system images by name, one may use the operational mode
-request ``show`` discussed in the next section; in this setting it would be:
+.. cfgcmd:: set service https certificates system-generated-certificate
-.. code-block:: none
+ Use an automatically generated self-signed certificate
- # curl -k -X POST -F data='{"op": "show", "path": ["system", "image"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/show
+.. cfgcmd:: set service https certificates system-generated-certificate
+ lifetime <days>
-Operational mode requests
--------------------------
+ Lifetime in days; default is 365
-It is possible to run ``show`` and ``generate`` commands:
+*********************
+Example Configuration
+*********************
-Request:
+Set an API-KEY is the minimal configuration to get a working API Endpoint.
.. code-block:: none
- curl -k -X POST -F data='{"op": "generate", "path": ["wireguard", "default-keypair"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/generate
-
-Response:
-
-.. code-block:: none
+ set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
- {"success": true, "data": "", "error": null}
-Request:
+To use this full configuration we asume a publice accessable hostname.
.. code-block:: none
- curl -k -X POST -F data='{"op": "show", "path": ["wireguard", "keypairs", "pubkey", "default"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/show
-
-Response:
-
-.. code-block:: none
-
- {"success": true, "data": "<some pubkey>=\n", "error": null}
-
-Request:
-
-.. code-block:: none
-
- curl -k -X POST -F data='{"op": "show", "path": ["ip", "route"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/show
-
-Response:
-
-.. code-block:: none
-
- {"success": true, "data": "Codes: K - kernel route, C - connected, S - static, R - RIP,\n O - OSPF, I - IS-IS, B - BGP, E - EIGRP, N - NHRP,\n T - Table, v - VNC, V - VNC-Direct, A - Babel, D - SHARP,\n F - PBR, f - OpenFabric,\n > - selected route, * - FIB route, q - queued route, r - rejected route\n\nS>* 0.0.0.0/0 [210/0] via 192.168.100.1, eth0, 01:41:05\nC>* 192.168.0.0/24 is directly connected, eth1, 01:41:09\nC>* 192.168.100.0/24 is directly connected, eth0, 01:41:05\nC>* 203.0.113.76/32 is directly connected, dum1, 01:38:40\n", "error": null}
-
+ set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
+ set service https certificates certbot domain-name rtr01.example.com
+ set service https certificates certbot email mail@example.com
+ set service https virtual-host rtr01 listen-address 198.51.100.2
+ set service https virtual-host rtr01 listen-port 11443
+ set service https virtual-host rtr01 server-name rtr01.example.com
+ set service https api-restrict virtual-host rtr01.example.com \ No newline at end of file
diff --git a/docs/configuration/service/ipoe-server.rst b/docs/configuration/service/ipoe-server.rst
index eea9517d..d8b9e6b7 100644
--- a/docs/configuration/service/ipoe-server.rst
+++ b/docs/configuration/service/ipoe-server.rst
@@ -41,8 +41,8 @@ the configuration.
set service ipoe-server authentication interface eth2 mac-address 08:00:27:2f:d8:06
set service ipoe-server authentication mode 'local'
- set service ipoe-server dns-server server-1 '10.10.1.1'
- set service ipoe-server dns-server server-2 '10.10.1.2'
+ set service ipoe-server name-server '10.10.1.1'
+ set service ipoe-server name-server '10.10.1.2'
set service ipoe-server interface eth2 client-subnet '192.168.0.0/24'
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 23:55:57 +0000