diff options
| author | Christian Breunig <christian@breunig.cc> | 2026-09-25 21:15:00 +0200 |
|---|---|---|
| committer | Christian Breunig <christian@breunig.cc> | 2026-09-25 21:15:00 +0200 |
| commit | 8de66862a56a5ed8557c4d0e0ac45e8659284ec5 (patch) | |
| tree | 0a63821d56d310bd40dd7c7b17ffce5158a63420 | |
| parent | 75d44591ed7cd7b6246f5d5f48722d70d11f7b98 (diff) | |
| download | vyos-documentation-T9354.tar.gz vyos-documentation-T9354.zip | |
T9354: document "reconnect interface" operational commandT9354
PPPoE, SSTP client and WWAN interfaces can now be restarted with a single
command which survives the loss of the CLI session, so it can be issued over
the very interface being reconnected. The WWAN page gained the connect and
disconnect commands as well - they have always been available there, but were
only documented for PPPoE and SSTP.
The command is also exposed by the HTTP API through a dedicated endpoint,
which replaces the "reset connection" path that was previously used for this.
| -rw-r--r-- | docs/automation/vyos-api.md | 19 | ||||
| -rw-r--r-- | docs/configuration/interfaces/pppoe.md | 8 | ||||
| -rw-r--r-- | docs/configuration/interfaces/sstp-client.md | 10 | ||||
| -rw-r--r-- | docs/configuration/interfaces/wwan.md | 21 |
4 files changed, 57 insertions, 1 deletions
diff --git a/docs/automation/vyos-api.md b/docs/automation/vyos-api.md index 224107f5..19524d7f 100644 --- a/docs/automation/vyos-api.md +++ b/docs/automation/vyos-api.md @@ -306,6 +306,25 @@ response: ``` +### /reconnect + +The `/reconnect` endpoint runs the `reconnect` command, which brings a +connection-oriented interface such as PPPoE or WWAN down and up again. + +```none +curl --location --request POST 'https://vyos/reconnect' \ +--form data='{"op": "reconnect", "path": ["interface", "pppoe0"]}' \ +--form key='MY-HTTPS-API-PLAINTEXT-KEY' + +response: +{ + "success": true, + "data": "", + "error": null +} +``` + + ### /reboot To initiate a reboot, use the `/reboot` endpoint. diff --git a/docs/configuration/interfaces/pppoe.md b/docs/configuration/interfaces/pppoe.md index b79f41a2..b531d5d6 100644 --- a/docs/configuration/interfaces/pppoe.md +++ b/docs/configuration/interfaces/pppoe.md @@ -332,6 +332,14 @@ Disconnect the specified interface. Initiate a session on the specified interface. ``` +```{opcmd} reconnect interface \<interface\> + +Reconnect the specified interface. The interface is disconnected and +connected again in a single operation which runs detached from the current +CLI session, so the command can safely be issued over the very interface +being reconnected. Progress is logged to the journal. +``` + ## Example diff --git a/docs/configuration/interfaces/sstp-client.md b/docs/configuration/interfaces/sstp-client.md index da98aecd..69fad213 100644 --- a/docs/configuration/interfaces/sstp-client.md +++ b/docs/configuration/interfaces/sstp-client.md @@ -167,4 +167,12 @@ Disconnect the specified interface. ```{opcmd} connect interface \<interface\> Initiate a session on the specified interface. -```
\ No newline at end of file +``` + +```{opcmd} reconnect interface \<interface\> + +Reconnect the specified interface. The interface is disconnected and +connected again in a single operation which runs detached from the current +CLI session, so the command can safely be issued over the very interface +being reconnected. Progress is logged to the journal. +``` diff --git a/docs/configuration/interfaces/wwan.md b/docs/configuration/interfaces/wwan.md index e8121f28..1063b2b8 100644 --- a/docs/configuration/interfaces/wwan.md +++ b/docs/configuration/interfaces/wwan.md @@ -313,6 +313,27 @@ PUK2 retries: '10' ``` +### Connect/disconnect + +```{opcmd} disconnect interface \<interface\> + +Disconnect the specified interface. +``` + +```{opcmd} connect interface \<interface\> + +Initiate a session on the specified interface. +``` + +```{opcmd} reconnect interface \<interface\> + +Reconnect the specified interface. The interface is disconnected and +connected again in a single operation which runs detached from the current +CLI session, so the command can safely be issued over the very interface +being reconnected. Progress is logged to the journal. +``` + + ## Example The following example shows how to configure a cellular connection using a |
