opnsense-docs/source/development/api/plugins/wireguard.rst

114 lines
5.4 KiB
ReStructuredText
Raw Normal View History

Wireguard
2018-09-22 05:27:11 -04:00
~~~~~~~~~
2023-09-18 07:19:28 -04:00
.. csv-table:: Resources (ClientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``POST``","wireguard","client","set",""
"``POST``","wireguard","client","setClient","$uuid"
"``POST``","wireguard","client","toggleClient","$uuid"
"``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","general","get",""
"``GET``","wireguard","general","getStatus",""
"``POST``","wireguard","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","server","addServer","$uuid=null"
"``POST``","wireguard","server","delServer","$uuid"
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
"``*``","wireguard","server","searchServer",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``POST``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ClientController.php)
2018-09-22 05:27:11 -04:00
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
2023-11-20 04:51:24 -05:00
"``GET``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
2021-03-08 06:22:26 -05:00
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","client","set",""
"``POST``","wireguard","client","setClient","$uuid"
"``POST``","wireguard","client","toggleClient","$uuid"
2018-09-22 05:27:11 -04:00
"``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
2021-03-08 06:22:26 -05:00
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","general","get",""
2022-11-24 13:06:26 -05:00
"``GET``","wireguard","general","getStatus",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","general","set",""
2021-03-08 06:22:26 -05:00
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ServerController.php)
2018-09-22 05:27:11 -04:00
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","server","addServer","$uuid=null"
"``POST``","wireguard","server","delServer","$uuid"
2021-03-08 06:22:26 -05:00
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
2023-09-18 07:19:28 -04:00
"``GET``","wireguard","server","keyPair",""
"``*``","wireguard","server","searchServer",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
2018-09-22 05:27:11 -04:00
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
2018-09-22 05:27:11 -04:00
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
2023-09-18 07:19:28 -04:00
"``POST``","wireguard","service","reconfigure",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
2023-09-18 07:19:28 -04:00
"``GET``","wireguard","service","show",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","service","start",""
2021-03-08 06:22:26 -05:00
"``GET``","wireguard","service","status",""
2022-10-19 11:21:08 -04:00
"``POST``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"