upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-04-23 23:28:18 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
opnsense-docs/source/development/api/core/interfaces.rst

135 lines
6.8 KiB
ReStructuredText
Raw Normal View History

API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
Interfaces
~~~~~~~~~~
api docs
2024-07-24 09:36:58 -04:00
.. csv-table:: Resources (GifSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","gif_settings","addItem",""
"``POST``","interfaces","gif_settings","delItem","$uuid"
"``GET``","interfaces","gif_settings","get",""
"``GET``","interfaces","gif_settings","getIfOptions",""
"``GET``","interfaces","gif_settings","getItem","$uuid=null"
"``POST``","interfaces","gif_settings","reconfigure",""
"``*``","interfaces","gif_settings","searchItem",""
"``POST``","interfaces","gif_settings","set",""
"``POST``","interfaces","gif_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Gif.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Gif.xml>`__"
.. csv-table:: Resources (GreSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","gre_settings","addItem",""
"``POST``","interfaces","gre_settings","delItem","$uuid"
"``GET``","interfaces","gre_settings","get",""
"``GET``","interfaces","gre_settings","getIfOptions",""
"``GET``","interfaces","gre_settings","getItem","$uuid=null"
"``POST``","interfaces","gre_settings","reconfigure",""
"``*``","interfaces","gre_settings","searchItem",""
"``POST``","interfaces","gre_settings","set",""
"``POST``","interfaces","gre_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Gre.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Gre.xml>`__"
update api docs (using scripts)
2023-09-18 07:19:28 -04:00
.. csv-table:: Resources (LaggSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","lagg_settings","addItem",""
"``POST``","interfaces","lagg_settings","delItem","$uuid"
"``GET``","interfaces","lagg_settings","get",""
"``GET``","interfaces","lagg_settings","getItem","$uuid=null"
"``POST``","interfaces","lagg_settings","reconfigure",""
"``*``","interfaces","lagg_settings","searchItem",""
"``POST``","interfaces","lagg_settings","set",""
"``POST``","interfaces","lagg_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Lagg.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Lagg.xml>`__"
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
.. csv-table:: Resources (LoopbackSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","loopback_settings","addItem",""
"``POST``","interfaces","loopback_settings","delItem","$uuid"
api: update core
2021-03-08 06:23:28 -05:00
"``GET``","interfaces","loopback_settings","get",""
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
"``GET``","interfaces","loopback_settings","getItem","$uuid=null"
"``POST``","interfaces","loopback_settings","reconfigure",""
"``*``","interfaces","loopback_settings","searchItem",""
API docs - update using script
2022-10-19 11:21:08 -04:00
"``POST``","interfaces","loopback_settings","set",""
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
"``POST``","interfaces","loopback_settings","setItem","$uuid"
fix previous
2020-04-07 14:53:31 -04:00
"``<<uses>>``", "", "", "", "*model* `Loopback.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Loopback.xml>`__"
API: core, add attached models in tables when using standard templates.
2020-04-07 14:49:44 -04:00
api endpoints (core)
2024-02-20 09:51:39 -05:00
.. csv-table:: Resources (NeighborSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","neighbor_settings","addItem",""
"``POST``","interfaces","neighbor_settings","delItem","$uuid"
"``GET``","interfaces","neighbor_settings","get",""
"``GET``","interfaces","neighbor_settings","getItem","$uuid=null"
"``POST``","interfaces","neighbor_settings","reconfigure",""
"``*``","interfaces","neighbor_settings","searchItem",""
"``POST``","interfaces","neighbor_settings","set",""
"``POST``","interfaces","neighbor_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Neighbor.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Neighbor.xml>`__"
.. csv-table:: Resources (OverviewController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","interfaces","overview","export",""
"``GET``","interfaces","overview","getInterface","$if=null"
"``GET``","interfaces","overview","interfacesInfo","$details=false"
"``GET``","interfaces","overview","reloadInterface","$identifier=null"
update API docs
2022-11-24 13:06:26 -05:00
.. csv-table:: Resources (VipSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","vip_settings","addItem",""
"``POST``","interfaces","vip_settings","delItem","$uuid"
"``GET``","interfaces","vip_settings","get",""
"``GET``","interfaces","vip_settings","getItem","$uuid=null"
"``GET``","interfaces","vip_settings","getUnusedVhid",""
"``POST``","interfaces","vip_settings","reconfigure",""
"``*``","interfaces","vip_settings","searchItem",""
"``POST``","interfaces","vip_settings","set",""
"``POST``","interfaces","vip_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Vip.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Vip.xml>`__"
Development - update api docs
2022-04-13 11:25:36 -04:00
.. csv-table:: Resources (VlanSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","vlan_settings","addItem",""
"``POST``","interfaces","vlan_settings","delItem","$uuid"
"``GET``","interfaces","vlan_settings","get",""
"``GET``","interfaces","vlan_settings","getItem","$uuid=null"
"``POST``","interfaces","vlan_settings","reconfigure",""
"``*``","interfaces","vlan_settings","searchItem",""
API docs - update using script
2022-10-19 11:21:08 -04:00
"``POST``","interfaces","vlan_settings","set",""
Development - update api docs
2022-04-13 11:25:36 -04:00
"``POST``","interfaces","vlan_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Vlan.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Vlan.xml>`__"
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
.. csv-table:: Resources (VxlanSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","vxlan_settings","addItem",""
"``POST``","interfaces","vxlan_settings","delItem","$uuid"
api: update core
2021-03-08 06:23:28 -05:00
"``GET``","interfaces","vxlan_settings","get",""
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
"``GET``","interfaces","vxlan_settings","getItem","$uuid=null"
"``POST``","interfaces","vxlan_settings","reconfigure",""
"``*``","interfaces","vxlan_settings","searchItem",""
API docs - update using script
2022-10-19 11:21:08 -04:00
"``POST``","interfaces","vxlan_settings","set",""
API: core api's 20.1 update
2020-02-16 10:08:40 -05:00
"``POST``","interfaces","vxlan_settings","setItem","$uuid"
API: core, add attached models in tables when using standard templates.
2020-04-07 14:49:44 -04:00
fix previous
2020-04-07 14:53:31 -04:00
"``<<uses>>``", "", "", "", "*model* `VxLan.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/VxLan.xml>`__"
Reference in a new issue Copy permalink