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

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"
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`Relayd`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`~~~~~~`

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`.. csv-table:: Service (ServiceController.php)`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``POST``","relayd","service","configtest",""
			"``POST``","relayd","service","reconfigure",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","relayd","service","reconfigure",""
			"``POST``","relayd","service","restart",""
			"``POST``","relayd","service","start",""
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","relayd","service","status",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","relayd","service","stop",""
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00
API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`.. csv-table:: Resources (SettingsController.php)`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``GET``","relayd","settings","del","$nodeType=null,$uuid=null"
			"``GET``","relayd","settings","dirty",""
			"``GET``","relayd","settings","get","$nodeType=null,$uuid=null"
21.7 update api endpoints 2021-07-28 09:59:13 -04:00			"``GET``","relayd","settings","get",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``POST``","relayd","settings","search","$nodeType=null"
			"``POST``","relayd","settings","set","$nodeType=null,$uuid=null"
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","relayd","settings","set",""
21.7 update api endpoints 2021-07-28 09:59:13 -04:00			"``POST``","relayd","settings","toggle","$nodeType,$uuid,$enabled=null"
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00
API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`.. csv-table:: Resources (StatusController.php)`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

21.7 update api endpoints 2021-07-28 09:59:13 -04:00			"``GET``","relayd","status","sum","$wait=0"
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``POST``","relayd","status","toggle","$nodeType=null,$id=null,$action=null"