mirror of https://github.com/opnsense/docs
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.
174 lines
7.7 KiB
ReStructuredText
174 lines
7.7 KiB
ReStructuredText
Ipsec
|
|
~~~~~
|
|
|
|
.. csv-table:: Resources (ConnectionsController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","connections","addChild",""
|
|
"``POST``","ipsec","connections","addConnection",""
|
|
"``POST``","ipsec","connections","addLocal",""
|
|
"``POST``","ipsec","connections","addRemote",""
|
|
"``GET``","ipsec","connections","connectionExists","$uuid"
|
|
"``POST``","ipsec","connections","delChild","$uuid"
|
|
"``POST``","ipsec","connections","delConnection","$uuid"
|
|
"``POST``","ipsec","connections","delLocal","$uuid"
|
|
"``POST``","ipsec","connections","delRemote","$uuid"
|
|
"``GET``","ipsec","connections","get",""
|
|
"``GET``","ipsec","connections","getChild","$uuid=null"
|
|
"``GET``","ipsec","connections","getConnection","$uuid=null"
|
|
"``GET``","ipsec","connections","getLocal","$uuid=null"
|
|
"``GET``","ipsec","connections","getRemote","$uuid=null"
|
|
"``GET``","ipsec","connections","isEnabled",""
|
|
"``*``","ipsec","connections","searchChild",""
|
|
"``*``","ipsec","connections","searchConnection",""
|
|
"``*``","ipsec","connections","searchLocal",""
|
|
"``*``","ipsec","connections","searchRemote",""
|
|
"``POST``","ipsec","connections","set",""
|
|
"``POST``","ipsec","connections","setChild","$uuid=null"
|
|
"``POST``","ipsec","connections","setConnection","$uuid=null"
|
|
"``POST``","ipsec","connections","setLocal","$uuid=null"
|
|
"``POST``","ipsec","connections","setRemote","$uuid=null"
|
|
"``POST``","ipsec","connections","toggle","$enabled=null"
|
|
"``POST``","ipsec","connections","toggleChild","$uuid,$enabled=null"
|
|
"``POST``","ipsec","connections","toggleConnection","$uuid,$enabled=null"
|
|
"``POST``","ipsec","connections","toggleLocal","$uuid,$enabled=null"
|
|
"``POST``","ipsec","connections","toggleRemote","$uuid,$enabled=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
|
|
|
|
.. csv-table:: Resources (KeyPairsController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","key_pairs","addItem",""
|
|
"``POST``","ipsec","key_pairs","delItem","$uuid"
|
|
"``GET``","ipsec","key_pairs","genKeyPair","$type,$size=null"
|
|
"``GET``","ipsec","key_pairs","get",""
|
|
"``GET``","ipsec","key_pairs","getItem","$uuid=null"
|
|
"``*``","ipsec","key_pairs","searchItem",""
|
|
"``POST``","ipsec","key_pairs","set",""
|
|
"``POST``","ipsec","key_pairs","setItem","$uuid=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
|
|
|
|
.. csv-table:: Resources (LeasesController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``GET``","ipsec","leases","pools",""
|
|
"``GET``","ipsec","leases","search",""
|
|
|
|
.. csv-table:: Resources (LegacySubsystemController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","legacy_subsystem","applyConfig",""
|
|
"``GET``","ipsec","legacy_subsystem","status",""
|
|
|
|
.. csv-table:: Resources (ManualSpdController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","manual_spd","add",""
|
|
"``POST``","ipsec","manual_spd","del","$uuid"
|
|
"``GET``","ipsec","manual_spd","get","$uuid=null"
|
|
"``GET``","ipsec","manual_spd","get",""
|
|
"``*``","ipsec","manual_spd","search",""
|
|
"``POST``","ipsec","manual_spd","set","$uuid=null"
|
|
"``POST``","ipsec","manual_spd","set",""
|
|
"``POST``","ipsec","manual_spd","toggle","$uuid,$enabled=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
|
|
|
|
.. csv-table:: Resources (PoolsController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","pools","add",""
|
|
"``POST``","ipsec","pools","del","$uuid"
|
|
"``GET``","ipsec","pools","get","$uuid=null"
|
|
"``GET``","ipsec","pools","get",""
|
|
"``*``","ipsec","pools","search",""
|
|
"``POST``","ipsec","pools","set","$uuid=null"
|
|
"``POST``","ipsec","pools","set",""
|
|
"``POST``","ipsec","pools","toggle","$uuid,$enabled=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
|
|
|
|
.. csv-table:: Resources (PreSharedKeysController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","pre_shared_keys","addItem",""
|
|
"``POST``","ipsec","pre_shared_keys","delItem","$uuid"
|
|
"``GET``","ipsec","pre_shared_keys","get",""
|
|
"``GET``","ipsec","pre_shared_keys","getItem","$uuid=null"
|
|
"``*``","ipsec","pre_shared_keys","searchItem",""
|
|
"``POST``","ipsec","pre_shared_keys","set",""
|
|
"``POST``","ipsec","pre_shared_keys","setItem","$uuid=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
|
|
|
|
.. csv-table:: Resources (SadController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","sad","delete","$id"
|
|
"``GET``","ipsec","sad","search",""
|
|
|
|
.. csv-table:: Service (ServiceController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","service","reconfigure",""
|
|
"``POST``","ipsec","service","restart",""
|
|
"``POST``","ipsec","service","start",""
|
|
"``GET``","ipsec","service","status",""
|
|
"``POST``","ipsec","service","stop",""
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `IPsec.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/IPsec.xml>`__"
|
|
|
|
.. csv-table:: Resources (SessionsController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","sessions","connect","$id"
|
|
"``POST``","ipsec","sessions","disconnect","$id"
|
|
"``GET``","ipsec","sessions","searchPhase1",""
|
|
"``GET``","ipsec","sessions","searchPhase2",""
|
|
|
|
.. csv-table:: Resources (SpdController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","spd","delete","$id"
|
|
"``GET``","ipsec","spd","search",""
|
|
|
|
.. csv-table:: Resources (TunnelController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","tunnel","delPhase1","$ikeid"
|
|
"``POST``","ipsec","tunnel","delPhase2","$seqid"
|
|
"``GET``","ipsec","tunnel","searchPhase1",""
|
|
"``GET``","ipsec","tunnel","searchPhase2",""
|
|
"``POST``","ipsec","tunnel","toggle","$enabled=null"
|
|
"``POST``","ipsec","tunnel","togglePhase1","$ikeid,$enabled=null"
|
|
"``POST``","ipsec","tunnel","togglePhase2","$seqid,$enabled=null"
|
|
|
|
.. csv-table:: Resources (VtiController.php)
|
|
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
|
:widths: 4, 15, 15, 30, 40
|
|
|
|
"``POST``","ipsec","vti","add",""
|
|
"``POST``","ipsec","vti","del","$uuid"
|
|
"``GET``","ipsec","vti","get","$uuid=null"
|
|
"``GET``","ipsec","vti","get",""
|
|
"``*``","ipsec","vti","search",""
|
|
"``POST``","ipsec","vti","set","$uuid=null"
|
|
"``POST``","ipsec","vti","set",""
|
|
"``POST``","ipsec","vti","toggle","$uuid,$enabled=null"
|
|
|
|
"``<<uses>>``", "", "", "", "*model* `Swanctl.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/IPsec/Swanctl.xml>`__"
|