You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
opensense-docs/source/development/api/plugins/relayd.rst

39 lines
1.7 KiB
ReStructuredText

Relayd
~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","relayd","service","configtest",""
"``POST``","relayd","service","reconfigure",""
"``POST``","relayd","service","reconfigure",""
"``POST``","relayd","service","restart",""
"``POST``","relayd","service","start",""
"``GET``","relayd","service","status",""
"``POST``","relayd","service","stop",""
"``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"
.. csv-table:: Resources (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","relayd","settings","del","$nodeType=null,$uuid=null"
"``GET``","relayd","settings","dirty",""
"``GET``","relayd","settings","get","$nodeType=null,$uuid=null"
"``GET``","relayd","settings","get",""
"``POST``","relayd","settings","search","$nodeType=null"
"``POST``","relayd","settings","set","$nodeType=null,$uuid=null"
"``POST``","relayd","settings","set",""
"``POST``","relayd","settings","toggle","$nodeType,$uuid,$enabled=null"
"``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"
.. csv-table:: Resources (StatusController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","relayd","status","sum","$wait=0"
"``POST``","relayd","status","toggle","$nodeType=null,$id=null,$action=null"